diff options
author | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2016-01-31 22:02:32 +0100 |
---|---|---|
committer | Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> | 2016-01-31 22:02:32 +0100 |
commit | a2eca72246ab40a0d96f6389c99e3a0b54e9342e (patch) | |
tree | bbce2cd1784893f7474e79c179bbe78671ac152b /docs/conf.py | |
parent | 770dd4b3fee1fe9f4e40a144777afb6030992149 (diff) | |
download | gitlab-a2eca72246ab40a0d96f6389c99e3a0b54e9342e.tar.gz |
Automatic doc generation for BaseManager classes
Provide a sphinx extension that parses the required/optioanl attributes
and add infoo to the class docstring.
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/docs/conf.py b/docs/conf.py index bbf3c67..c5c1fad 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,15 +21,11 @@ import sys import sphinx sys.path.append('../') +sys.path.append(os.path.dirname(__file__)) import gitlab on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -if sphinx.version_info < (1,3,): - napoleon_version = "sphinxcontrib.napoleon" -else: - napoleon_version = "sphinx.ext.napoleon" - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -44,7 +40,7 @@ sys.path.insert(0, os.path.abspath('..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', napoleon_version, + 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'ext.docstrings' ] # Add any paths that contain templates here, relative to this directory. |