Configuration de sphinx-multiversion

Installation : pip install sphinx-multiversion
Utilisation : make html_versions
This commit is contained in:
Youen 2023-05-17 20:25:31 +02:00
parent 06d5b55bf4
commit c5a2a6e495
5 changed files with 67 additions and 9 deletions

View file

@ -1,13 +1,17 @@
# Configuration file for the Sphinx documentation builder.
# Configuration file for the Sphinx documentation builder.
import sys, os
sys.path.append(os.path.abspath('exts'))
# -- Project information
project = 'Guide de montage Vheliotech'
copyright = '2023, Velo solaire pour tous'
author = 'Association Velo Solaire Pour Tous'
project = 'Guide de montage Vhéliotech'
copyright = '2023, Vélo solaire pour tous'
author = 'Association Vélo Solaire Pour Tous'
release = '1.0.0'
version = '1.0.0'
html_context = dict()
html_context['version'] = 'test'
# -- General configuration
@ -19,6 +23,8 @@ extensions = [
'sphinx.ext.intersphinx',
'myst_parser',
'sphinxcontrib.inkscapeconverter',
'sphinx_multiversion',
'rtd_current_version',
]
myst_enable_extensions = [
@ -55,5 +61,11 @@ html_css_files = [
'html-version.css'
]
# -- Options for EPUB output
epub_show_urls = 'footnote'
html_theme_options = {
'display_version': True
}
# sphinx-multiversion settings
smv_branch_whitelist = r'^main$'
smv_tag_whitelist = r'^v[0-9\.]+$'
smv_released_pattern = r'^tags/.*$'