Oliver Walters 2019-04-28 00:03:19 +10:00
parent a499fd325e
commit 4aef8eecea
2 changed files with 17 additions and 3 deletions

2
.gitignore vendored
View File

@ -29,8 +29,6 @@ local_settings.py
# Sphinx files
docs/_build
docs/_static
docs/_templates
# Local media storage (only when running in development mode)
InvenTree/media

View File

@ -28,6 +28,7 @@ copyright = '2019, InvenTree'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'autoapi.extension',
]
@ -37,6 +38,12 @@ napoleon_numpy_docstring = False
autoapi_dirs = [
'../InvenTree',
'../Inventree/build',
'../InvenTree/company',
'../InvenTree/InvenTree',
'../InvenTree/part',
'../InvenTree/stock',
'../InvenTree/users',
]
autoapi_options = [
@ -60,7 +67,8 @@ autoapi_ignore = [
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
autoapi_template_dir = 'templates'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@ -85,3 +93,11 @@ html_theme = 'sphinx_rtd_theme'
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Table of contents in sidebar
html_sidebars = {'**': [
'globaltoc.html',
'relations.html',
'sourcelink.html',
'searchbox.html'
]}