mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-28 19:46:46 +00:00
Use sphinx-autoapi to generate documentation files
- Select which files to ignore - Only display items with a docstring
This commit is contained in:
parent
0cec12085d
commit
ad3defffe3
22
docs/conf.py
22
docs/conf.py
@ -28,14 +28,24 @@ copyright = '2019, InvenTree'
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.coverage',
|
'autoapi.extension'
|
||||||
'sphinx.ext.napoleon',
|
|
||||||
'sphinx.ext.viewcode',
|
|
||||||
]
|
]
|
||||||
|
|
||||||
napoleon_google_docstring = False
|
autoapi_dirs = [
|
||||||
napoleon_use_param = False
|
'../InvenTree',
|
||||||
napoleon_use_ivar = True
|
]
|
||||||
|
|
||||||
|
autoapi_options = [
|
||||||
|
'members',
|
||||||
|
]
|
||||||
|
|
||||||
|
autoapi_type = 'python'
|
||||||
|
|
||||||
|
autoapi_ignore = [
|
||||||
|
'*migrations*',
|
||||||
|
'**/test*.py',
|
||||||
|
'**/manage.py'
|
||||||
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
|
@ -1,2 +1,3 @@
|
|||||||
Sphinx>=2.0.1
|
Sphinx>=2.0.1
|
||||||
sphinx_rtd_theme==0.4.3
|
sphinx-auto-api==1.0.0
|
||||||
|
sphinx-rtd-theme==0.4.3
|
Loading…
x
Reference in New Issue
Block a user