conf#

Configuration file for the Sphinx documentation builder.

This file does only contain 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.

Module Contents#

Functions#

_get_project_meta() → Dict[str, str]

Attributes#

_get_project_meta() Dict[str, str][source]#
pkg_meta[source]#
project[source]#
copyright[source]#
author = fire-square[source]#
version[source]#
release[source]#
needs_sphinx = 3.3[source]#
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage',...[source]#
autoclass_content = class[source]#
autodoc_member_order = bysource[source]#
autodoc_default_flags[source]#
set_type_checking_flag = True[source]#
templates_path = ['_templates'][source]#
source_suffix = ['.rst', '.md'][source]#
master_doc = index[source]#
language = ru[source]#
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_autoapi_templates/*'][source]#
pygments_style = sphinx[source]#
add_module_names = False[source]#
autodoc_default_options[source]#
html_theme = furo[source]#
html_theme_options[source]#
html_static_path = ['_static'][source]#
napoleon_include_private_with_doc = True[source]#
autoapi_dirs = ['..'][source]#
autoapi_template_dir = _autoapi_templates[source]#
autoapi_ignore = ['*/migrations/*', '*/tests/*'][source]#
todo_include_todos = True[source]#
PY3[source]#
string_types[source]#
SUFFIX[source]#
html_static_path = [][source]#
using_rtd_theme[source]#
theme[source]#
websupport2_base_url = https://readthedocs.org/websupport[source]#
context[source]#
html_baseurl[source]#
html_context[source]#
extensions = ['readthedocs_ext.readthedocs'][source]#
readthedocs_vcs_url = None[source]#
project_language = en[source]#
language_user[source]#
latex_engine_user[source]#
latex_elements_user[source]#
latex_use_xindy = False[source]#
chinese[source]#
japanese[source]#
latex_engine[source]#
exclude_patterns[source]#