Skip to content

Commit 4a75060

Browse files
committed
Rename python-client.md
1 parent 83e7318 commit 4a75060

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

dev/generate_python_client_md.sh

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,35 +30,35 @@ cd $ROOT/pkg/workloads/cortex/client
3030

3131
pip3 install -e .
3232

33-
pydoc-markdown -m cortex -m cortex.client --render-toc > $ROOT/docs/miscellaneous/python_client.md
33+
pydoc-markdown -m cortex -m cortex.client --render-toc > $ROOT/docs/miscellaneous/python-client.md
3434

3535
# title
36-
sed -i "s/# Table of Contents/# Python client\n\n_WARNING: you are on the master branch, please refer to the docs on the branch that matches your \`cortex version\`_/g" $ROOT/docs/miscellaneous/python_client.md
36+
sed -i "s/# Table of Contents/# Python client\n\n_WARNING: you are on the master branch, please refer to the docs on the branch that matches your \`cortex version\`_/g" $ROOT/docs/miscellaneous/python-client.md
3737

3838
# delete links
39-
sed -i "/<a name=/d" $ROOT/docs/miscellaneous/python_client.md
39+
sed -i "/<a name=/d" $ROOT/docs/miscellaneous/python-client.md
4040

4141
# delete unnecessary section headers
42-
sed -i "/_](#cortex\.client\.Client\.__init__)/d" $ROOT/docs/miscellaneous/python_client.md
43-
sed -i "/\* \[Client](#cortex\.client\.Client)/d" $ROOT/docs/miscellaneous/python_client.md
42+
sed -i "/_](#cortex\.client\.Client\.__init__)/d" $ROOT/docs/miscellaneous/python-client.md
43+
sed -i "/\* \[Client](#cortex\.client\.Client)/d" $ROOT/docs/miscellaneous/python-client.md
4444
# fix section link/header
45-
sed -i "s/\* \[cortex\.client](#cortex\.client)/\* [cortex\.client\.Client](#cortex-client-client)/g" $ROOT/docs/miscellaneous/python_client.md
46-
sed -i "s/# cortex\.client/# cortex\.client\.Client/g" $ROOT/docs/miscellaneous/python_client.md
45+
sed -i "s/\* \[cortex\.client](#cortex\.client)/\* [cortex\.client\.Client](#cortex-client-client)/g" $ROOT/docs/miscellaneous/python-client.md
46+
sed -i "s/# cortex\.client/# cortex\.client\.Client/g" $ROOT/docs/miscellaneous/python-client.md
4747
# delete unnecessary section body
48-
sed -i "/# cortex.client.Client/,/## deploy/{//!d}" $ROOT/docs/miscellaneous/python_client.md
49-
sed -i "s/# cortex.client.Client/# cortex.client.Client\n/g" $ROOT/docs/miscellaneous/python_client.md
48+
sed -i "/# cortex.client.Client/,/## deploy/{//!d}" $ROOT/docs/miscellaneous/python-client.md
49+
sed -i "s/# cortex.client.Client/# cortex.client.Client\n/g" $ROOT/docs/miscellaneous/python-client.md
5050

5151
# fix table of contents links
52-
sed -i "s/](#cortex\./](#/g" $ROOT/docs/miscellaneous/python_client.md
53-
sed -i "s/](#client\.Client\./](#/g" $ROOT/docs/miscellaneous/python_client.md
52+
sed -i "s/](#cortex\./](#/g" $ROOT/docs/miscellaneous/python-client.md
53+
sed -i "s/](#client\.Client\./](#/g" $ROOT/docs/miscellaneous/python-client.md
5454

5555
# indentdation
56-
sed -i "s/ \* / \* /g" $ROOT/docs/miscellaneous/python_client.md
57-
sed -i "s/#### /## /g" $ROOT/docs/miscellaneous/python_client.md
56+
sed -i "s/ \* / \* /g" $ROOT/docs/miscellaneous/python-client.md
57+
sed -i "s/#### /## /g" $ROOT/docs/miscellaneous/python-client.md
5858

5959
# whitespace
60-
sed -i 's/[[:space:]]*$//' $ROOT/docs/miscellaneous/python_client.md
61-
truncate -s -1 $ROOT/docs/miscellaneous/python_client.md
60+
sed -i 's/[[:space:]]*$//' $ROOT/docs/miscellaneous/python-client.md
61+
truncate -s -1 $ROOT/docs/miscellaneous/python-client.md
6262

6363
pip3 uninstall -y cortex
6464

docs/summary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
## Miscellaneous
4949

5050
* [CLI commands](miscellaneous/cli.md)
51-
* [Python client](miscellaneous/python_client.md)
51+
* [Python client](miscellaneous/python-client.md)
5252
* [Environments](miscellaneous/environments.md)
5353
* [Architecture diagram](miscellaneous/architecture.md)
5454
* [Security](miscellaneous/security.md)

0 commit comments

Comments
 (0)