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

This commit is contained in:
Goffi 2026-11-03 21:01:23 +01:00
commit 1003cd2c6d

View file

@ -60,6 +60,9 @@ rst_prolog = """
# ones.
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.
templates_path = [".templates"]
@ -82,7 +85,8 @@ language = "en"
# 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 = [".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.
pygments_style = None
@ -120,7 +124,7 @@ html_static_path = [".static"]
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = "SalutToidoc"
htmlhelp_basename = "LiberviaBackenddoc"
# -- Options for LaTeX output ------------------------------------------------
@ -144,7 +148,13 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
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 = [
(
master_doc,
"SalutToi",
"Libervia Documentation",
"LiberviaBackend",
"Libervia Backend Documentation",
author,
"SalutToi",
"LiberviaBackend",
"One line description of project.",
"Miscellaneous",
),