Changeset 152bf4f for doc

Timestamp:

Oct 30, 2018, 2:32:51 PM (6 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master

Children:

8986239

Parents:

ed596f7

Message:

[doc] start adding autodoc to sphinx documents

Location:

doc

Files:

• conf.py (modified) (1 diff)
• index.rst (modified) (1 diff)
• python.rst (added)

doc/conf.py

@@ -30 +30 @@
 # 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.viewcode', 'sphinx.ext.autodoc']
+extensions = ['sphinx.ext.viewcode', 'sphinx.ext.autodoc',
+        'sphinx.ext.napoleon', 'sphinx.ext.intersphinx']
+
+autodoc_member_order = 'groupwise'
+
+intersphinx_mapping = {
+        'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+        }
 
 # Add any paths that contain templates here, relative to this directory.

doc/index.rst

@@ -71 +71 @@
    installing
    python_module
+   python
    cli
    develop