From 92ac8236a94244402e5a1594134dc54e84f1592d Mon Sep 17 00:00:00 2001 From: Rastislav Rabatin Date: Mon, 12 Jun 2017 22:53:18 +0200 Subject: [PATCH] Add napolean sphinx extension to allow parsing docstrings in various formats See the discussion on mailinglist: --- docs/src/Makefile | 3 +++ docs/src/conf.py | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/src/Makefile b/docs/src/Makefile index 6edac0c761..3cfac1dd24 100644 --- 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 index dafd56c42c..d804df3c82 100644 --- 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.