diff --git a/docs/source/.gitignore b/docs/source/.gitignore index 8cc04bd..57dcc67 100644 --- a/docs/source/.gitignore +++ b/docs/source/.gitignore @@ -2,3 +2,4 @@ !.gitignore !conf.py !index.rst +!cli.rst diff --git a/docs/source/cli.rst b/docs/source/cli.rst new file mode 100644 index 0000000..3a2d2c3 --- /dev/null +++ b/docs/source/cli.rst @@ -0,0 +1,3 @@ +.. click:: vmanage.__main__:vmanage + :prog: vmanage + :nested: full \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 8da74d8..1c3a01d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,7 +34,8 @@ "sphinx_rtd_theme", 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'm2r' + 'm2r', + 'sphinx_click', ] extensions.append('autoapi.extension') diff --git a/docs/source/index.rst b/docs/source/index.rst index abaa3cb..878a1a0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Welcome to the Python Viptela SDK documentation! -========================================== +================================================ `python-viptela` provides a Python SDK for interacting with Cisco SDWAN (formerly Viptela). @@ -13,6 +13,8 @@ Welcome to the Python Viptela SDK documentation! :caption: Contents: autoapi/index.rst + cli + Indices and tables ================== diff --git a/requirements.txt b/requirements.txt index 640f2c0..0c4db30 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,6 +4,7 @@ PyYAML requests sphinx>=2.1.2,<3.0 sphinx-autoapi==1.3.0 +sphinx-click>=1.3.0 sphinx-markdown==1.0.2 sphinx-markdown-builder==0.5.4 sphinx_rtd_theme==0.4.3