mirror of
https://github.com/pds-nest/nest.git
synced 2024-11-24 22:14:18 +00:00
93 lines
3.3 KiB
Python
93 lines
3.3 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:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- 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
|
|
import pkg_resources
|
|
sys.path.insert(0, os.path.abspath('..'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'N.E.S.T. Backend'
|
|
copyright = '2021, Gruppo 2'
|
|
author = 'Gruppo 2'
|
|
release = pkg_resources.get_distribution("nest_backend").version
|
|
|
|
|
|
# -- 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.intersphinx",
|
|
'sphinx.ext.todo',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
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']
|
|
|
|
# Print warnings on the page
|
|
keep_warnings = True
|
|
|
|
# Display more warnings than usual
|
|
nitpicky = True
|
|
|
|
|
|
# -- 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']
|
|
|
|
|
|
# -- Intersphinx options -----------------------------------------------------
|
|
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3.8", None),
|
|
"sqlalchemy": ("https://docs.sqlalchemy.org/en/14/", None),
|
|
"flask": ("https://flask.palletsprojects.com/en/1.1.x/", None),
|
|
"flask_sqlalchemy": ("https://flask-sqlalchemy.palletsprojects.com/en/2.x/", None),
|
|
"flask_jwt_extended": ("https://flask-jwt-extended.readthedocs.io/en/stable/", None),
|
|
"flask_cors": ("https://flask-cors.readthedocs.io/en/latest/", None),
|
|
"requests": ("https://docs.python-requests.org/en/master/", None),
|
|
"apispec": ("https://apispec.readthedocs.io/en/latest/", None),
|
|
"marshmallow": ("https://marshmallow.readthedocs.io/en/stable/", None),
|
|
"tweepy": ("https://docs.tweepy.org/en/latest/", None),
|
|
"nltk": ("https://www.nltk.org/", None),
|
|
}
|
|
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
# -- Automodule settings -----------------------------------------------------
|
|
|
|
autodoc_default_options = {
|
|
'members': True,
|
|
'member-order': 'bysource',
|
|
'special-members': '__init__',
|
|
'undoc-members': True,
|
|
'show-inheritance': True,
|
|
}
|