docs-requirements.txt: Add sphinx-argparse

Add the required module for the documentation page to work. docs/Developers/Doc_coala_Settings.rst: Add the documentation page Uses the module installed to generate the documentation page using the default_arg_parser function. docs/conf.py: Add the extension Add the extension for sphinx in the configuration file docs/index.rst:Adds Doc page in index Add the documentation page in the index file so it appears. Closes coala/documentation#40
paniabhisek · Dec 18, 2016 · 9136c03 · 9136c03
1 parent 7f4edb8
commit 9136c03
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -2,3 +2,4 @@
 -r requirements.txt
 -r test-requirements.txt
 sphinx~=1.4.9
+sphinx-argparse~=0.1.15
diff --git a/docs/Developers/coala_settings.rst b/docs/Developers/coala_settings.rst
@@ -0,0 +1,7 @@
+Documentation coala settings
+============================
+
+.. argparse::
+   :module: coalib.parsing.DefaultArgParser
+   :func: default_arg_parser
+   :prog: coala
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
     'sphinx.ext.viewcode',
+    'sphinxarg.ext',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
@@ -29,6 +29,7 @@ If you're trying to **use** coala, you should have a look at our
    :hidden:
 
    Newcomers' Guide <Developers/Newcomers_Guide>
+   Documentation coala settings <Developers/coala_settings>
    Bear Installation Tool <Developers/Bear_Installation_Tool>
    Writing Good Commit Messages <Developers/Writing_Good_Commits>
    Codestyle <Developers/Codestyle>