📚 Add docs for the CLI

glotaran · Aug 22, 2021 · 26a80ba · 26a80ba
1 parent a464ec3
commit 26a80ba
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 1 deletion.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,6 @@
 # documentation dependencies
 Sphinx>=3.2.0
+sphinx-click>=3.0.1
 sphinx-rtd-theme>=0.5.1
 sphinx-copybutton>=0.3.0
 myst-parser>=0.12.0

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -49,6 +49,7 @@
     "sphinx.ext.imgmath",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
+    "sphinx_click",
     "nbsphinx",
     "sphinx_last_updated_by_git",
     "myst_parser",

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -27,6 +27,7 @@ Welcome to pyglotaran's documentation!
    user_documentation/parameter
    user_documentation/optimizing
    user_documentation/using_plugins
+   user_documentation/cli
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/source/user_documentation/cli.rst b/docs/source/user_documentation/cli.rst
@@ -0,0 +1,6 @@
+Command-line Interface
+======================
+
+.. click:: glotaran.cli:main
+   :prog: glotaran
+   :nested: full
diff --git a/setup.cfg b/setup.cfg
@@ -73,7 +73,7 @@ glotaran.plugins.project_io =
 test = pytest
 
 [rstcheck]
-ignore_directives = autoattribute,autoclass,autoexception,autofunction,automethod,automodule,highlight
+ignore_directives = autoattribute,autoclass,autoexception,autofunction,automethod,automodule,highlight,click
 ignore_messages = xarraydoc
 
 [darglint]