erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc (conf.py): update project name and exclude the TUI documentation

Browse source
This commit is contained in:
Goffi 2026-11-03 21:01:23 +01:00
commit 1003cd2c6d
1 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
doc/conf.py
View file

@ -60,6 +60,9 @@ rst_prolog = """
# ones. # ones.
extensions = ["sphinx.ext.autodoc", "docstring", "sphinxcontrib.autodoc_pydantic"] extensions = ["sphinx.ext.autodoc", "docstring", "sphinxcontrib.autodoc_pydantic"]
# do not show pydantic field constraints (custom validators are not meaningful here)
autodoc_pydantic_field_show_constraints = False
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = [".templates"] templates_path = [".templates"]
@ -82,7 +85,8 @@ language = "en"
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [".build", "Thumbs.db", ".DS_Store"] # the TUI is temporarily on hold and broken, its documentation is excluded
exclude_patterns = [".build", "Thumbs.db", ".DS_Store", "libervia-tui"]
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = None pygments_style = None
@ -120,7 +124,7 @@ html_static_path = [".static"]
# -- Options for HTMLHelp output --------------------------------------------- # -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = "SalutToidoc" htmlhelp_basename = "LiberviaBackenddoc"
# -- Options for LaTeX output ------------------------------------------------ # -- Options for LaTeX output ------------------------------------------------
@ -144,7 +148,13 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, "SalutToi.tex", "Libervia Documentation", "Libervia team", "manual"), (
master_doc,
"LiberviaBackend.tex",
"Libervia Backend Documentation",
"Libervia team",
"manual",
),
] ]
@ -163,10 +173,10 @@ man_pages = [(master_doc, "saluttoi", "Libervia Documentation", [author], 1)]
texinfo_documents = [ texinfo_documents = [
( (
master_doc, master_doc,
"SalutToi", "LiberviaBackend",
"Libervia Documentation", "Libervia Backend Documentation",
author, author,
"SalutToi", "LiberviaBackend",
"One line description of project.", "One line description of project.",
"Miscellaneous", "Miscellaneous",
), ),