mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
100 lines
2.7 KiB
Python
100 lines
2.7 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# http://www.sphinx-doc.org/en/master/config
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# 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.
|
|
#
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('../'))
|
|
sys.path.append(os.path.abspath('../InvenTree'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'InvenTree'
|
|
copyright = '2019, InvenTree'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'autoapi.extension',
|
|
]
|
|
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = False
|
|
|
|
autoapi_dirs = [
|
|
'../InvenTree',
|
|
]
|
|
|
|
autoapi_options = [
|
|
'members',
|
|
'private-members',
|
|
'special-members',
|
|
]
|
|
|
|
autoapi_type = 'python'
|
|
|
|
autoapi_ignore = [
|
|
'*migrations*',
|
|
'**/test*.py',
|
|
'**/manage.py',
|
|
'**/apps.py',
|
|
'**/admin.py',
|
|
'**/middleware.py',
|
|
'**/utils.py',
|
|
'**/wsgi.py',
|
|
'**/templates/',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
autoapi_template_dir = 'templates'
|
|
autoapi_root = 'docs'
|
|
autoapi_add_toctree_entry = False
|
|
|
|
templates_path = ['templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = [
|
|
'_build',
|
|
'Thumbs.db',
|
|
'.DS_Store',
|
|
'manage.rst', # Ignore django management file
|
|
'**/*.migrations*.rst', # Ignore migration files
|
|
]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# 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'
|
|
]} |