Home · Quickstart · User Guide and Examples · Interfaces Index · Developers · About · Nipy

# nipype.sphinxext.apidoc package

Settings for sphinxext.interfaces and connection to sphinx-apidoc.

class nipype.sphinxext.apidoc.Config(**settings: Any)

  Bases: `sphinx.ext.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 that `nipype.sphinxext.interfaces` is enabled in `conf.py`:

      # conf.py

      # Add this extension to the corresponding list:
      extensions = ['nipype.sphinxext.interfaces']

      # NiPype settings
      nipype_references = False

  nipype_skip_classes

    True to include referenced publications with the interface (requires duecredit to be installed).

    Type:

      `bool` (Defaults to True)

nipype.sphinxext.apidoc.setup(app: Sphinx) → Dict[unicode, Any]

  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

  See also

  The Sphinx documentation on Extensions The Extension Tutorial The Extension API

## Submodules

- nipype.sphinxext.apidoc.docstring module