nipype.sphinxext.apidoc package¶
Settings for sphinxext.interfaces and connection to sphinx-apidoc.
- class nipype.sphinxext.apidoc.Config(**settings)¶
Bases:
sphinxcontrib.napoleon.Config
Sphinx-nipype extension settings in
conf.py
.Listed below are all the settings used by this extension and their default values. These settings can be changed in the Sphinx’s
conf.py
file. Make sure thatnipype.sphinxext.interfaces
is enabled inconf.py
:# conf.py # Add this extension to the corresponding list: extensions = ['nipype.sphinxext.interfaces'] # NiPype settings nipype_references = False
- Attributes
nipype_skip_classes (
bool
(Defaults to True)) – True to include referenced publications with the interface (requires duecredit to be installed).
- nipype.sphinxext.apidoc.setup(app)¶
Sphinx extension setup function.
When the extension is loaded, Sphinx imports this module and executes the
setup()
function, which in turn notifies Sphinx of everything the extension offers.- Parameters
app (sphinx.application.Sphinx) – Application object representing the Sphinx process