Use sphinx-autoapi to generate documentation files

- Select which files to ignore
- Only display items with a docstring
This commit is contained in:
Oliver Walters 2019-04-27 17:19:51 +10:00
parent 0cec12085d
commit ad3defffe3
2 changed files with 18 additions and 7 deletions

View File

@ -28,14 +28,24 @@ copyright = '2019, InvenTree'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.coverage',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'autoapi.extension'
]
napoleon_google_docstring = False
napoleon_use_param = False
napoleon_use_ivar = True
autoapi_dirs = [
'../InvenTree',
]
autoapi_options = [
'members',
]
autoapi_type = 'python'
autoapi_ignore = [
'*migrations*',
'**/test*.py',
'**/manage.py'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

View File

@ -1,2 +1,3 @@
Sphinx>=2.0.1
sphinx_rtd_theme==0.4.3
sphinx-auto-api==1.0.0
sphinx-rtd-theme==0.4.3