Bug 1419772 - [docs] Enable the sphinx.ext.napoleon extension, r?gps
This enables sphinx to parse both the google and numpy style docstring
formats which tend to be more human readable than the default sphinx
format.
See:
http://www.sphinx-doc.org/en/stable/ext/napoleon.html
MozReview-Commit-ID: REmZ4IoUG8
--- a/tools/docs/conf.py
+++ b/tools/docs/conf.py
@@ -31,16 +31,17 @@ EXTRA_PATHS = (
sys.path[:0] = [os.path.join(topsrcdir, p) for p in EXTRA_PATHS]
sys.path.insert(0, OUR_DIR)
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.graphviz',
+ 'sphinx.ext.napoleon',
'sphinx.ext.todo',
'mozbuild.sphinx',
'sphinx_js',
]
# JSDoc must run successfully for dirs specified, so running
# tree-wide (the default) will not work currently.
js_source_path = ['toolkit/mozapps/extensions']