119 lignes
3.8 KiB
Python
119 lignes
3.8 KiB
Python
"""
|
|
Documentation build's configuration for Benevalibre.
|
|
|
|
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
|
|
"""
|
|
import os
|
|
import sys
|
|
import django
|
|
|
|
sys.path.insert(0, os.path.abspath('../..'))
|
|
from benevalibre.settings import DJANGO_SETTINGS_MODULE
|
|
|
|
os.environ.setdefault('DJANGO_SETTINGS_MODULE', DJANGO_SETTINGS_MODULE)
|
|
django.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.
|
|
sys.path.insert(0, os.path.abspath('../../'))
|
|
|
|
# sys.setrecursionlimit(1500) # default is usually about 1000
|
|
|
|
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'benevalibre.settings.test')
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
from benevalibre import __version__ # noqa: E402
|
|
|
|
project = "Bénévalibre"
|
|
author = "Cliss XXI"
|
|
copyright = "2019, Cliss XXI, released under the GNU AGPLv3+ License"
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The short X.Y version.
|
|
version = __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 = '1.0'
|
|
|
|
# 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']
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix(es) of source filenames.
|
|
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 = 'fr'
|
|
|
|
# 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 = []
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = None
|
|
|
|
|
|
# -- 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'
|
|
|
|
# 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 = {'logo_only': True}
|
|
|
|
# The name for this set of Sphinx documents. If None, it defaults to
|
|
# "<project> v<release> documentation".
|
|
html_title = "Documentation de Bénévalibre"
|
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
html_short_title = "Documentation"
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
html_logo = '../../artwork/benevalibre-white.svg'
|
|
|
|
# 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']
|
|
|
|
# If true, the reST sources are included in the HTML build as _sources/name.
|
|
html_copy_source = False
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
html_show_sourcelink = False
|
|
|
|
# Tweak rendering
|
|
def setup(app):
|
|
app.add_stylesheet('css/custom.css')
|