Bug 1419772 - [docs] Enable the sphinx.ext.napoleon extension, r=gps
authorAndrew Halberstadt <ahalberstadt@mozilla.com>
Wed, 22 Nov 2017 10:17:12 -0500
changeset 393086 7cc1270bf794f1e2354a93fd8d508f121f959bcf
parent 393085 96de9eeb020a9ca1109b2844e03e08f48801ef0b
child 393087 f5dafe8991b323b824768bc2e9bc0979f2f7f8a8
child 393200 345fd2d2bf806427935a2b466b8fc3ecb5d804ab
push id32953
push usershindli@mozilla.com
push dateWed, 22 Nov 2017 21:28:42 +0000
treeherdermozilla-central@f5dafe8991b3 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgps
bugs1419772
milestone59.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
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
tools/docs/conf.py
--- 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']