mirror of
https://github.com/Balshgit/public.git
synced 2025-09-11 18:00:42 +03:00
137 lines
4.3 KiB
Python
137 lines
4.3 KiB
Python
# wemake-django-template documentation build configuration file, created by
|
|
# sphinx-quickstart on Sat Sep 30 12:42:34 2017.
|
|
#
|
|
# This file is execfile()d with the current directory set to its
|
|
# containing dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
# 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
|
|
from contextlib import suppress
|
|
|
|
import tomlkit
|
|
|
|
sys.path.insert(0, os.path.abspath('..'))
|
|
|
|
# We need this block, because
|
|
# django might be not installed, maybe we are running our
|
|
# build process in ReadTheDocs?
|
|
# https://github.com/wemake-services/wemake-django-template/issues/133
|
|
with suppress(ImportError):
|
|
import django # noqa: WPS433
|
|
|
|
# Normal django setup. That's how it should be in development:
|
|
os.environ['DJANGO_SETTINGS_MODULE'] = 'server.settings'
|
|
django.setup()
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
def _get_project_meta():
|
|
with open('../pyproject.toml') as pyproject:
|
|
file_contents = pyproject.read()
|
|
|
|
return tomlkit.parse(file_contents)['tool']['poetry']
|
|
|
|
|
|
pkg_meta = _get_project_meta()
|
|
project = str(pkg_meta['name'])
|
|
author = str(pkg_meta['authors'][0])
|
|
copyright = author # noqa: WPS125
|
|
|
|
# The short X.Y version
|
|
version = str(pkg_meta['version'])
|
|
# The full version, including alpha/beta/rc tags
|
|
release = version
|
|
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
needs_sphinx = '3.3'
|
|
|
|
# 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.doctest',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.coverage',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.githubpages',
|
|
'sphinx.ext.napoleon',
|
|
|
|
# 3rd party, order matters:
|
|
# https://github.com/wemake-services/wemake-django-template/issues/159
|
|
'sphinx_autodoc_typehints',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
source_suffix = ['.rst']
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# 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 = None
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This patterns also effect to html_static_path and html_extra_path
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = 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 = 'alabaster'
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
html_theme_options = {}
|
|
|
|
# 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']
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
# to template names.
|
|
#
|
|
# This is required for the alabaster theme
|
|
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
|
html_sidebars = {
|
|
'**': [
|
|
'about.html',
|
|
'navigation.html',
|
|
'moreinfo.html',
|
|
'searchbox.html',
|
|
],
|
|
}
|