From 78656f1e1268909b90f751fdb3177ec4226d81dd Mon Sep 17 00:00:00 2001 From: Josh Date: Sun, 7 Sep 2025 10:58:08 -0400 Subject: [PATCH] refactor(dev): clean up Sphinx config / bring up-to-date Signed-off-by: Josh --- developer_manual/conf.py | 407 ++++++++++++--------------------------- 1 file changed, 125 insertions(+), 282 deletions(-) diff --git a/developer_manual/conf.py b/developer_manual/conf.py index 24623a67ed3..3ad871a30d5 100644 --- a/developer_manual/conf.py +++ b/developer_manual/conf.py @@ -1,331 +1,174 @@ -# -*- coding: utf-8 -*- +## These are the configuration elements for the Nextcloud Developer Manual documentation # -# Nextcloud Documentation documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 22 23:16:40 2012-2014. +# Configuration file for the Sphinx documentation builder. # -# This file is execfile()d with the current directory set to its containing dir. +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html # -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# import global configuration from parent directory -sys.path.insert(0, os.path.abspath('../')) -from conf import * - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions += ['sphinx.ext.todo', 'rst2pdf.pdfbuilder', 'sphinx.ext.intersphinx', 'sphinxcontrib.phpdomain', 'sphinx_toolbox.collapse', 'sphinx_reredirects'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['../_shared_assets/templates', '_templates'] +## Note that additional configuration elements shared by all Nextcloud docs +## are loaded from `../conf.py`. -# The suffix of source filenames. -source_suffix = '.rst' +# -- Path setup -------------------------------------------------------------- -# The encoding of source files. -#source_encoding = 'utf-8-sig' +import os +import sys -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Nextcloud %s Developer Manual' % (version) -#copyright = u'2012-2017, The Nextcloud developers' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -#version = '13' -# The full version, including alpha/beta/rc tags. -#release = '13' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# Import Nextcloud's shared global documentation configuration (from parent) +sys.path.insert(0, os.path.abspath("../")) +from conf import * -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True +from sphinx.builders.html import StandaloneHTMLBuilder -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +project = "Nextcloud %s Developer Manual" % (version) -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration +# Note: `+=` must be used here because we're extending the inherited list of extensions from our global docs config +extensions += [ + "sphinx.ext.todo", + "rst2pdf.pdfbuilder", + "sphinx.ext.intersphinx", + "sphinxcontrib.phpdomain", + "sphinx_toolbox.collapse", + "sphinx_reredirects", +] -# -- Options for HTML output --------------------------------------------------- +templates_path = [ + "../_shared_assets/templates", + "_templates", +] -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} +exclude_patterns = [ + "_build", +] -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ['../_shared_assets/themes'] +highlight_options = { + "php": {"startinline": True}, +} -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# html_theme = 'sphinx_rtd_theme' -# html_theme_options = { -# # "rightsidebar": "true", -# } -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# A shorter title for the navigation bar. Default is the same as html_title. +html_theme_path = ["../_shared_assets/themes"] +html_static_path = [ + "../_shared_assets/static", + "_static", +] +# prefer a shorter title for the navigation bar. html_short_title = "Developer Manual" +# disable "Created using Sphinx" in the HTML footer (default is True) +html_show_sphinx = False -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['../_shared_assets/static', '_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False +html_last_updated_fmt = "%b %d, %Y" -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# -- Options for HTML help output -------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-help-output -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -html_show_sphinx = False +# output file base name for HTML help builder. +htmlhelp_basename = "NextcloudDeveloperManual" -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# -- Options for HTML builder image support ---------------------------------- +# https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.html.StandaloneHTMLBuilder -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' +# prefer gif over png (when both are found); useful for animated gifs +StandaloneHTMLBuilder.supported_image_types = [ + "image/svg+xml", + "image/gif", + "image/png", + "image/jpeg", +] -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# -- Options for EPUB output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-epub-output -# Output file base name for HTML help builder. -htmlhelp_basename = 'NextcloudDeveloperManual' +epub_title = "Nextcloud Developer Manual" +epub_author = "The Nextcloud developers" +epub_publisher = "The Nextcloud developers" +epub_copyright = "2012-2024, The Nextcloud developers" -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------ +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -'preamble': '\extrafloats{100}\maxdeadcycles=500\DeclareUnicodeCharacter{274C}{\sffamily X}', + "preamble": "\extrafloats{100}\maxdeadcycles=500\DeclareUnicodeCharacter{274C}{\sffamily X}", } - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'NextcloudDeveloperManual.tex', u'Nextcloud Developer Manual', - u'The Nextcloud developers', 'manual'), + ( + "index", + "NextcloudDeveloperManual.tex", + "Nextcloud Developer Manual", + "The Nextcloud developers", + "manual", + ), ] +latex_logo = "../_shared_assets/static/logo-blue.pdf" -# The name of an image file (relative to this directory) to place at the top of -# the title page. -latex_logo = '../_shared_assets/static/logo-blue.pdf' - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] +# -- Options for manual page output ------------------------------------------ -# If false, no module index is generated. -#latex_domain_indices = True - -# -- Options for pdf page output ----------------------------------------------- - -pdf_documents = [('index', u'NextcloudDeveloperManual', u'Nextcloud Developer Manual', - u'The Nextcloud developers'),] - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'NextcloudDeveloperManual', u'Nextcloud Developer Manual', - [u'The Nextcloud developers'], 1) + ( + "index", + "NextcloudDeveloperManual", + "Nextcloud Developer Manual", + ["The Nextcloud developers"], + 1, + ) ] -# If true, show URL addresses after external links. -#man_show_urls = False - +# -- Options for Texinfo output ---------------------------------------------- -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) texinfo_documents = [ - ('index', 'NextcloudDeveloperManual', u'Nextcloud Developer Manual', - u'The Nextcloud developers', 'Nextcloud', 'The Nextcloud Developer Manual.', - 'Miscellaneous'), + ( + "index", + "NextcloudDeveloperManual", + "Nextcloud Developer Manual", + "The Nextcloud developers", + "Nextcloud", + "The Nextcloud Developer Manual.", + "Miscellaneous", + ), ] -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - +# -- Options for todo extension ---------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'Nextcloud Developer Manual' -epub_author = u'The Nextcloud developers' -epub_publisher = u'The Nextcloud developers' -epub_copyright = u'2012-2024, The Nextcloud developers' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Include todos? todo_include_todos = True -current_docs = 'developer_manual' +# -- Options for PDF page output --------------------------------------------- +# https://rst2pdf.org/manual.html#sphinx -from sphinx.builders.html import StandaloneHTMLBuilder -StandaloneHTMLBuilder.supported_image_types = [ - 'image/svg+xml', - 'image/gif', - 'image/png', - 'image/jpeg' +pdf_documents = [ + ( + "index", + "NextcloudDeveloperManual", + "Nextcloud Developer Manual", + "The Nextcloud developers", + ), ] -# Generate the versions list -html_context['versions'] = generateVersionsDocs(current_docs) -html_context['theme_vcs_pageview_mode'] += current_docs +# -- Custom Nextcloud docs context ------------------------------------------- +# Generate the versions list for inclusion into all HTML pages +current_docs = "developer_manual" +html_context["versions"] = generateVersionsDocs(current_docs) +html_context["theme_vcs_pageview_mode"] += current_docs -highlight_options = { - 'php': {'startinline': True}, -} - -# Redirect old URLs +# -- URL redirects ----------------------------------------------------------- # https://documatt.gitlab.io/sphinx-reredirects/usage.html + redirects = { - # Removed 2023 - "core/index": "../server", - "core/code-back-end": "../server/code-back-end.html", - "core/code-front-end": "../server/code-front-end.html", - "core/externalapi": "../server/externalapi.html", - "core/static-analysis": "../server/static-analysis.html", - "core/unit-testing": "../server/unit-testing.html", - # Removed 2024-09 - "digging_deeper/changelog": "../app_publishing_maintenance/app_upgrade_guide/index.html", - # Removed 2025-04 - "basics/front-end/l10n": "../translations.html" + # Removed 2023 + "core/index": "../server", + "core/code-back-end": "../server/code-back-end.html", + "core/code-front-end": "../server/code-front-end.html", + "core/externalapi": "../server/externalapi.html", + "core/static-analysis": "../server/static-analysis.html", + "core/unit-testing": "../server/unit-testing.html", + # Removed 2024-09 + "digging_deeper/changelog": "../app_publishing_maintenance/app_upgrade_guide/index.html", + # Removed 2025-04 + "basics/front-end/l10n": "../translations.html", }