Merge pull request #1411 from rasto2211/napoleon

Add napolean sphinx extension to allow parsing docstrings in various formats
piskvorky · Jun 14, 2017 · f64ce71 · f64ce71
2 parents fbe6db0 + 92ac823
commit f64ce71
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/src/Makefile b/docs/src/Makefile
@@ -1,5 +1,8 @@
 # Makefile for Sphinx documentation
 #
+# In order to compile this documentation you need to have sphinx
+# and sphinxcontrib-napoleon. You can install them using:
+# pip3 install sphinx sphinxcontrib-napoleon
 
 # You can set these variables from the command line.
 SPHINXOPTS    =

diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -24,7 +24,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']
 autoclass_content = "both"
 
 # Add any paths that contain templates here, relative to this directory.