113 lines
3.4 KiB
Python
113 lines
3.4 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 = 'GnomeZworc doc\'s'
|
|
copyright = '2023, Nicolas Boufidjeline'
|
|
author = 'Nicolas Boufidjeline'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# 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 = '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 = []
|
|
|
|
# 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']
|
|
|
|
|
|
|
|
|
|
|
|
# == NDD DOCKER SPHINX - OVERRIDE ============================================
|
|
|
|
|
|
# -- 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 = [
|
|
'recommonmark',
|
|
|
|
'sphinx.ext.graphviz',
|
|
'sphinx.ext.ifconfig',
|
|
# 'sphinx.ext.imgmath',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx.ext.todo',
|
|
|
|
'sphinx_copybutton',
|
|
'sphinx-prompt',
|
|
'sphinxemoji.sphinxemoji',
|
|
|
|
'sphinxcontrib.actdiag',
|
|
'sphinxcontrib.blockdiag',
|
|
'sphinxcontrib.excel_table',
|
|
'sphinxcontrib.git_context',
|
|
'sphinxcontrib.mermaid',
|
|
'sphinxcontrib.nwdiag',
|
|
'sphinxcontrib.packetdiag',
|
|
'sphinxcontrib.plantuml',
|
|
'sphinxcontrib.rackdiag',
|
|
'sphinxcontrib.seqdiag',
|
|
]
|
|
|
|
# If true, 'todo' and 'todoList' produce output, else they produce nothing.
|
|
todo_include_todos = True
|
|
|
|
|
|
# -- HTML --------------------------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
# Must be defined somewhere
|
|
html_context = {}
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
#
|
|
# html_logo = '_static/logo.png'
|
|
|
|
# The name of an image file (relative to this directory) to use as a favicon of
|
|
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
# pixels large.
|
|
#
|
|
# html_favicon = '_static/favicon.ico'
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
#
|
|
html_show_sourcelink = False
|
|
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
#
|
|
html_show_sphinx = False
|