Skip to content

Instantly share code, notes, and snippets.

@mivade
Created September 23, 2014 07:43
Show Gist options
  • Save mivade/4a8f1c626442a414d0b1 to your computer and use it in GitHub Desktop.
Save mivade/4a8f1c626442a414d0b1 to your computer and use it in GitHub Desktop.
Sphinx notes

Sphinx notes

Standard extensions

Usually, the numpydoc format is the easiest to use and read for docstrings. In order to make things Just Work, use the following in conf.py:

extensions = [
  'sphinx.ext.autodoc',
  'sphinx.ext.autosummary',
  'sphinx.ext.doctest',
  'sphinx.ext.intersphinx',
  'sphinx.ext.todo',
  'sphinx.ext.coverage',
  'sphinx.ext.mathjax',
  'sphinx.ext.viewcode',
  'numpydoc'
]
numpydoc_show_class_members = False
autosummary_generate = False
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment