Web M&M
https://mam.matfyz.cz
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
101 lines
3.4 KiB
101 lines
3.4 KiB
# 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 django
|
|
sys.path.insert(0, os.path.abspath('..'))
|
|
os.environ['DJANGO_SETTINGS_MODULE'] = 'mamweb.settings'
|
|
django.setup()
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'Web M&M'
|
|
copyright = '2022, Orgové'
|
|
author = 'Orgové'
|
|
|
|
|
|
# -- 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.viewcode',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.autosectionlabel',
|
|
'myst_parser',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = 'cs'
|
|
|
|
# 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']
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
import sphinx_rtd_theme
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
# 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']
|
|
|
|
# Provázání s jinými dokumentacemi
|
|
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
|
|
'django': ('http://docs.djangoproject.com/en/3.2/',
|
|
'http://docs.djangoproject.com/en/3.2/_objects/'),}
|
|
|
|
# Generování tříd/funkcí/atributů v pořádí jak jsou naprogramované
|
|
autodoc_member_order = "bysource"
|
|
|
|
# Nezobrazování zděděné (ze super tříd) dokumentace TODO nefunguje?
|
|
autodoc_inherit_docstrings = False
|
|
|
|
source_suffix = {
|
|
'.rst': 'restructuredtext',
|
|
'.md': 'markdown',
|
|
}
|
|
|
|
# Autodoc má ignorovat některé moduly
|
|
# Ref: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#event-autodoc-skip-member
|
|
# Kudos: https://stackoverflow.com/a/21449475/
|
|
def ignorovat(app, what, name, obj, skip, options):
|
|
blacklist = (
|
|
# typ (what), name
|
|
('module', 'settings.mamweb_prod'),
|
|
)
|
|
ignore = (what, name) in blacklist
|
|
return True if ignore else None
|
|
|
|
def setup(app):
|
|
app.connect('autodoc-skip-member', ignorovat)
|
|
|