docs: premiere creation de documentation
Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
parent
9a46b5cde7
commit
cb904c4744
34 changed files with 1896 additions and 30 deletions
34
docs/conf.py
34
docs/conf.py
|
|
@ -6,31 +6,43 @@
|
|||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'Two doc\'s'
|
||||
copyright = '2023, Nicolas Boufidjeline'
|
||||
project = 'two'
|
||||
copyright = '2026, Nicolas Boufidjeline'
|
||||
author = 'Nicolas Boufidjeline'
|
||||
version = '0.1'
|
||||
release = '0.1.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = []
|
||||
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 = []
|
||||
|
||||
extensions = [
|
||||
'myst_parser',
|
||||
'sphinxcontrib.mermaid'
|
||||
]
|
||||
|
||||
html_show_sphinx = False
|
||||
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
html_theme_options = {
|
||||
'home_page_in_toc': True,
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue