two/docs/conf.py
GnomeZworc 6c629e4e8d
add build conf
Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
2026-09-09 23:37:27 +02:00

63 lines
1.7 KiB
Python

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'two'
copyright = '2026, Nicolas Boufidjeline'
author = 'Nicolas Boufidjeline'
version = '0.1'
release = '0.1.0'
# -- General configuration ---------------------------------------------------
templates_path = ['_templates']
exclude_patterns = ['_build', 'README.md', 'requirements.txt', 'schemas']
language = 'fr'
extensions = [
'myst_parser',
'sphinxcontrib.mermaid',
'sphinxcontrib.openapi',
]
myst_enable_extensions = [
'colon_fence',
'deflist',
]
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_book_theme'
html_static_path = []
html_show_sphinx = False
# Le thème publie le source de chaque page dans _sources/ et l'expose derrière
# un bouton de téléchargement. Les deux vont ensemble : couper la copie sans
# couper le bouton laisserait un lien mort vers un répertoire vide.
html_copy_source = False
html_show_sourcelink = False
html_theme_options = {
'home_page_in_toc': True,
'use_download_button': False,
'icon_links': [
{
'name': 'Dépôt',
'url': 'https://git.g3e.fr/syonad/two',
'icon': 'fa-solid fa-code-branch',
'type': 'fontawesome',
},
],
}