61 lines
2.1 KiB
Python
61 lines
2.1 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
|
||
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
||
|
|
|
||
|
|
|
||
|
|
# -- Project information -----------------------------------------------------
|
||
|
|
|
||
|
|
project = 'multi-user'
|
||
|
|
copyright = '2020, Swann Martinez'
|
||
|
|
author = 'Swann Martinez'
|
||
|
|
|
||
|
|
# The full version, including alpha/beta/rc tags
|
||
|
|
release = '0.0.1'
|
||
|
|
|
||
|
|
|
||
|
|
# -- 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 = [
|
||
|
|
]
|
||
|
|
|
||
|
|
# 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 = 'python'
|
||
|
|
|
||
|
|
# 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 -------------------------------------------------
|
||
|
|
|
||
|
|
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
|
||
|
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||
|
|
|
||
|
|
import sphinx_rtd_theme
|
||
|
|
html_theme = 'sphinx_rtd_theme'
|
||
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||
|
|
if on_rtd:
|
||
|
|
using_rtd_theme = True
|