diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2016-11-14 15:40:01 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2016-11-14 15:40:01 +0900 |
| commit | 1943c2ff1a950b0a5a99ea08fd6b8baf5b1e2445 (patch) | |
| tree | 2134de0916c47214de5c87b652e1a05745689c2e /doc/source/conf.py | |
| parent | b5fb8a21a5eaaf820355f5bfbfc2bda48df12d29 (diff) | |
| download | buildstream-1943c2ff1a950b0a5a99ea08fd6b8baf5b1e2445.tar.gz | |
Docs configuration changes
- Enable sphinx.ext.napoleon extension
Allows generation of docs from nicer looking docstrings
- autodoc_member_order = 'bysource'
Ensure class/module documentation orders the docs in the same
order documentation was encountered in the source code
Diffstat (limited to 'doc/source/conf.py')
| -rw-r--r-- | doc/source/conf.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index a3e40594b..f40887f9a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,6 +32,7 @@ sys.path.insert(0, os.path.abspath('..')) # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.napoleon', ] # Add any paths that contain templates here, relative to this directory. @@ -339,3 +340,5 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. # # texinfo_no_detailmenu = False + +autodoc_member_order = 'bysource' |