Sphinx 8.1.0__tar.gz → 8.1.2__tar.gz

{sphinx-8.1.0 → sphinx-8.1.2}/CHANGES.rst

@@ -1,3 +1,30 @@
+Release 8.1.2 (released Oct 12, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #13012: Expose :exc:`sphinx.errors.ExtensionError` in ``sphinx.util``
+  for backwards compatibility.
+  This will be removed in Sphinx 9, as exposing the exception
+  in ``sphinx.util`` was never intentional.
+  :exc:`!ExtensionError` has been part of ``sphinx.errors`` since Sphinx 0.9.
+  Patch by Adam Turner.
+
+Release 8.1.1 (released Oct 11, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #13006: Use the preferred https://www.cve.org/ URL for
+  the :rst:role:`:cve: <cve>` role.
+  Patch by Hugo van Kemenade.
+* #13007: LaTeX: Improve resiliency when the required
+  ``fontawesome`` or ``fontawesome5`` packages are not installed.
+  Patch by Jean-François B.
+
+
 Release 8.1.0 (released Oct 10, 2024)
 =====================================
 

{sphinx-8.1.0 → sphinx-8.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Sphinx
-Version: 8.1.0
+Version: 8.1.2
 Summary: Python documentation generator
 Author-email: Georg Brandl <georg@python.org>
 Requires-Python: >=3.10
@@ -80,6 +80,7 @@ Requires-Dist: setuptools>=70.0 ; extra == "test"
 Requires-Dist: typing_extensions>=4.9 ; extra == "test"
 Project-URL: Changelog, https://www.sphinx-doc.org/en/master/changes.html
 Project-URL: Code, https://github.com/sphinx-doc/sphinx
+Project-URL: Documentation, https://www.sphinx-doc.org/
 Project-URL: Download, https://pypi.org/project/Sphinx/
 Project-URL: Homepage, https://www.sphinx-doc.org/
 Project-URL: Issue tracker, https://github.com/sphinx-doc/sphinx/issues

sphinx-8.1.2/doc/_static/diagrams/sphinx_build_flow.dot

@@ -0,0 +1,81 @@
+// UML for the standard Sphinx build workflow
+
+digraph build {
+    graph [
+        rankdir=LR
+    ];
+    node [
+        shape=rect
+        style=rounded
+    ];
+
+    "Sphinx" [
+        shape=record
+        label = "Sphinx | <init> __init__ | <build> build"
+    ];
+    "legend" [
+        shape=record
+        label = <<table border="0" cellborder="0" cellspacing="0">
+            <tr><td align="center"><u><b>Method types</b></u></td></tr>
+            <tr><td align="left"><font color="darkorange">Final</font></td></tr>
+            <tr><td align="left"><font color="darkblue">Overridable</font></td></tr>
+            <tr><td align="left"><font color="darkgreen">Abstract</font></td></tr>
+        </table>>
+    ];
+    {rank=same; "Sphinx" "legend" };
+
+    "Builder.init" [color=darkblue];
+    "Builder.build_all" [color=darkorange];
+    "Builder.build_specific" [color=darkorange];
+    "Builder.build_update" [color=darkorange];
+
+    "Sphinx":init -> "Builder.init";
+    "Sphinx":build -> "Builder.build_all";
+    "Sphinx":build -> "Builder.build_specific";
+    "Sphinx":build -> "Builder.build_update";
+
+    "Builder.get_outdated_docs" [color=darkgreen];
+    "Builder.build_update" -> "Builder.get_outdated_docs";
+
+    "Builder.build" [color=darkorange];
+
+    "Builder.build_all" -> "Builder.build";
+    "Builder.build_specific" -> "Builder.build";
+    "Builder.build_update":p1 -> "Builder.build";
+
+    "Builder.read" [color=darkorange];
+    "Builder.write" [color=darkorange];
+    "Builder.finish" [color=darkblue];
+
+    "Builder.build" -> "Builder.read";
+    "Builder.build" -> "Builder.write";
+    "Builder.build" -> "Builder.finish";
+
+    "Builder.read_doc" [color=darkorange];
+    "Builder.write_doctree" [color=darkorange];
+
+    "Builder.read" -> "Builder.read_doc";
+    "Builder.read_doc" -> "Builder.write_doctree";
+
+    "Builder.prepare_writing" [color=darkblue];
+    "Builder.copy_assets" [color=darkblue];
+    "Builder.write_documents" [color=darkblue];
+
+    "Builder.write":p1 -> "Builder.prepare_writing";
+    "Builder.write":p1 -> "Builder.copy_assets";
+    "Builder.write_documents" [
+        shape=record
+        label = "<p1> Builder.write_documents | Builder._write_serial | Builder._write_parallel"
+    ];
+    "Builder.write":p1 -> "Builder.write_documents";
+
+    "Builder.write_doc" [color=darkgreen];
+    "Builder.get_relative_uri" [color=darkblue];
+
+    "Builder.write_documents":p1 -> "Builder.write_doc";
+    "Builder.write_doc" -> "Builder.get_relative_uri";
+
+    "Builder.get_target_uri" [color=darkgreen];
+
+    "Builder.get_relative_uri" -> "Builder.get_target_uri";
+}

{sphinx-8.1.0 → sphinx-8.1.2}/doc/development/html_themes/templating.rst

@@ -308,20 +308,13 @@ in the future.
    .. versionadded:: 4.0
 
 .. data:: master_doc
+          root_doc
 
-   Same as :data:`root_doc`.
+   The value of :confval:`master_doc` or :confval:`root_doc` (aliases),
+   for usage with :func:`pathto`.
 
-   .. versionchanged:: 4.0
-
-      Renamed to ``root_doc``.
-
-.. data:: root_doc
-
-   The value of :confval:`root_doc`, for usage with :func:`pathto`.
-
-   .. versionchanged:: 4.0
-
-      Renamed from ``master_doc``.
+   .. versionadded:: 4.0
+      The :data:`!root_doc` template variable.
 
 .. data:: pagename
 

{sphinx-8.1.0 → sphinx-8.1.2}/doc/development/tutorials/examples/autodoc_intenum.py

@@ -35,16 +35,15 @@ class IntEnumDocumenter(ClassDocumenter):
     def add_content(
         self,
         more_content: StringList | None,
-        no_docstring: bool = False,
     ) -> None:
-        super().add_content(more_content, no_docstring)
+        super().add_content(more_content)
 
         source_name = self.get_sourcename()
         enum_object: IntEnum = self.object
         use_hex = self.options.hex
         self.add_line('', source_name)
 
-        for the_member_name, enum_member in enum_object.__members__.items():
+        for the_member_name, enum_member in enum_object.__members__.items():  # type: ignore[attr-defined]
             the_member_value = enum_member.value
             if use_hex:
                 the_member_value = hex(the_member_value)

{sphinx-8.1.0 → sphinx-8.1.2}/doc/extdev/builderapi.rst

@@ -12,11 +12,11 @@ Builder API
    It follows this basic workflow:
 
    .. graphviz:: /_static/diagrams/sphinx_build_flow.dot
-      :caption: UML for the standard Sphinx build workflow
+      :caption: Call graph for the standard Sphinx build workflow
 
    .. rubric:: Overridable Attributes
 
-   These attributes should be set on builder sub-classes:
+   These class attributes should be set on builder sub-classes:
 
    .. autoattribute:: name
    .. autoattribute:: format
@@ -29,8 +29,7 @@ Builder API
 
    .. rubric:: Core Methods
 
-   These methods are predefined and should generally not be overridden,
-   since they form the core of the build process:
+   These methods define the core build workflow and must not be overridden:
 
    .. automethod:: build_all
    .. automethod:: build_specific
@@ -73,11 +72,12 @@ Builder API
    Builder sub-classes can set these attributes to support built-in extensions:
 
    .. attribute:: supported_linkcode
+      :type: str
 
       By default, the :mod:`linkcode <sphinx.ext.linkcode>` extension will
       only inject references for an ``html`` builder.
-      The ``supported_linkcode`` attribute can be defined in a non-HTML builder
-      to support managing references generated by linkcode.
+      The ``supported_linkcode`` class attribute can be defined in a
+      non-HTML builder to support managing references generated by linkcode.
       The expected value for this attribute is an expression
       which is compatible with :rst:dir:`only`.
 

{sphinx-8.1.0 → sphinx-8.1.2}/doc/glossary.rst

@@ -75,10 +75,8 @@ Glossary
      For more information, refer to :doc:`/usage/extensions/index`.
 
    master document
-      The document that contains the root :rst:dir:`toctree` directive.
-
    root document
-      Same as :term:`master document`.
+      The document that contains the root :rst:dir:`toctree` directive.
 
    object
       The basic building block of Sphinx documentation.  Every "object

{sphinx-8.1.0 → sphinx-8.1.2}/doc/internals/contributing.rst

@@ -270,12 +270,14 @@ you to preview in :file:`build/sphinx/html`.
 
 You can also build a **live version of the documentation** that you can preview
 in the browser. It will detect changes and reload the page any time you make
-edits. To do so, run the following command:
+edits.
+To do so, use `sphinx-autobuild`_ to run the following command:
 
 .. code-block:: shell
 
    sphinx-autobuild ./doc ./build/sphinx/
 
+.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
 
 Translations
 ~~~~~~~~~~~~

{sphinx-8.1.0 → sphinx-8.1.2}/doc/usage/quickstart.rst

@@ -148,6 +148,17 @@ Sphinx will build HTML files.
    Refer to the :doc:`sphinx-build man page </man/sphinx-build>`
    for all options that :program:`sphinx-build` supports.
 
+You can also build a **live version of the documentation** that you can preview
+in the browser.
+It will detect changes and reload the page any time you make edits.
+To do so, use `sphinx-autobuild`_ to run the following command:
+
+.. code-block:: console
+
+   $ sphinx-autobuild source-dir output-dir
+
+.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
+
 However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a
 :file:`make.bat` which make life even easier for you. These can be executed by
 running :command:`make` with the name of the builder. For example.

{sphinx-8.1.0 → sphinx-8.1.2}/pyproject.toml

@@ -9,6 +9,7 @@ description = "Python documentation generator"
 readme = "README.rst"
 urls.Changelog = "https://www.sphinx-doc.org/en/master/changes.html"
 urls.Code = "https://github.com/sphinx-doc/sphinx"
+urls.Documentation = "https://www.sphinx-doc.org/"
 urls.Download = "https://pypi.org/project/Sphinx/"
 urls.Homepage = "https://www.sphinx-doc.org/"
 urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx/issues"
@@ -139,6 +140,8 @@ exclude = [
 [tool.mypy]
 files = [
     "doc/conf.py",
+    "doc/development/tutorials/examples/autodoc_intenum.py",
+    "doc/development/tutorials/examples/helloworld.py",
     "sphinx",
     "tests",
     "utils",

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/__init__.py

@@ -1,6 +1,6 @@
 """The Sphinx documentation toolchain."""
 
-__version__ = '8.1.0'
+__version__ = '8.1.2'
 __display_version__ = __version__  # used for command line version
 
 # Keep this file executable as-is in Python 3!
@@ -30,7 +30,7 @@ warnings.filterwarnings(
 #:
 #: .. versionadded:: 1.2
 #:    Before version 1.2, check the string ``sphinx.__version__``.
-version_info = (8, 1, 0, 'final', 0)
+version_info = (8, 1, 2, 'final', 0)
 
 package_dir = os.path.abspath(os.path.dirname(__file__))
 

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/builders/__init__.py

@@ -59,14 +59,20 @@ class Builder:
     Builds target formats from the reST sources.
     """
 
-    #: The builder's name, for the -b command line option.
-    name = ''
+    #: The builder's name.
+    #: This is the value used to select builders on the command line.
+    name: str = ''
     #: The builder's output format, or '' if no document output is produced.
-    format = ''
-    #: The message emitted upon successful build completion. This can be a
-    #: printf-style template string with the following keys: ``outdir``,
-    #: ``project``
-    epilog = ''
+    #: This is commonly the file extension, e.g. "html",
+    #: though any string value is accepted.
+    #: The builder's format string can be used by various components
+    #: such as :class:`.SphinxPostTransform` or extensions to determine
+    #: their compatibility with the builder.
+    format: str = ''
+    #: The message emitted upon successful build completion.
+    #: This can be a printf-style template string
+    #: with the following keys: ``outdir``, ``project``
+    epilog: str = ''
 
     #: default translator class for the builder.  This can be overridden by
     #: :py:meth:`~sphinx.application.Sphinx.set_translator`.
@@ -74,8 +80,8 @@ class Builder:
     # doctree versioning method
     versioning_method = 'none'
     versioning_compare = False
-    #: allow parallel write_doc() calls
-    allow_parallel = False
+    #: Whether it is safe to make parallel :meth:`~.Builder.write_doc()` calls.
+    allow_parallel: bool = False
     # support translation
     use_message_catalog = True
 
@@ -83,9 +89,9 @@ class Builder:
     #: Image files are searched in the order in which they appear here.
     supported_image_types: list[str] = []
     #: The builder can produce output documents that may fetch external images when opened.
-    supported_remote_images = False
+    supported_remote_images: bool = False
     #: The file format produced by the builder allows images to be embedded using data-URIs.
-    supported_data_uri_images = False
+    supported_data_uri_images: bool = False
 
     def __init__(self, app: Sphinx, env: BuildEnvironment) -> None:
         self.srcdir = app.srcdir
@@ -159,7 +165,7 @@ class Builder:
     def get_relative_uri(self, from_: str, to: str, typ: str | None = None) -> str:
         """Return a relative URI between two source filenames.
 
-        May raise environment.NoUri if there's no way to return a sensible URI.
+        :raises: :exc:`!NoUri` if there's no way to return a sensible URI.
         """
         return relative_uri(
             self.get_target_uri(from_),
@@ -789,7 +795,16 @@ class Builder:
         pass
 
     def write_doc(self, docname: str, doctree: nodes.document) -> None:
-        """Where you actually write something to the filesystem."""
+        """
+        Write the output file for the document
+
+        :param docname: the :term:`docname <document name>`.
+        :param doctree: defines the content to be written.
+
+        The output filename must be determined within this method,
+        typically by calling :meth:`~.Builder.get_target_uri`
+        or :meth:`~.Builder.get_relative_uri`.
+        """
         raise NotImplementedError
 
     def write_doc_serialized(self, docname: str, doctree: nodes.document) -> None:

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/environment/__init__.py

@@ -54,10 +54,6 @@ default_settings: dict[str, Any] = {
     'image_loading': 'link',
     'embed_stylesheet': False,
     'cloak_email_addresses': True,
-    'cve_base_url': 'https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-',
-    'cve_references': None,
-    'cwe_base_url': 'https://cwe.mitre.org/data/definitions/',
-    'cwe_references': None,
     'pep_base_url': 'https://peps.python.org/',
     'pep_references': None,
     'rfc_base_url': 'https://datatracker.ietf.org/doc/html/',

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/roles.py

@@ -17,6 +17,7 @@ from sphinx.util.docutils import ReferenceRole, SphinxRole
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
+    from typing import Final
 
     from docutils.nodes import Element, Node, TextElement, system_message
 
@@ -197,6 +198,8 @@ class AnyXRefRole(XRefRole):
 
 
 class CVE(ReferenceRole):
+    _BASE_URL: Final = 'https://www.cve.org/CVERecord?id=CVE-'
+
     def run(self) -> tuple[list[Node], list[system_message]]:
         target_id = f'index-{self.env.new_serialno("index")}'
         entries = [
@@ -233,14 +236,15 @@ class CVE(ReferenceRole):
         return [index, target, reference], []
 
     def build_uri(self) -> str:
-        base_url = self.inliner.document.settings.cve_base_url
         ret = self.target.split('#', 1)
         if len(ret) == 2:
-            return f'{base_url}{ret[0]}#{ret[1]}'
-        return f'{base_url}{ret[0]}'
+            return f'{CVE._BASE_URL}{ret[0]}#{ret[1]}'
+        return f'{CVE._BASE_URL}{ret[0]}'
 
 
 class CWE(ReferenceRole):
+    _BASE_URL: Final = 'https://cwe.mitre.org/data/definitions/'
+
     def run(self) -> tuple[list[Node], list[system_message]]:
         target_id = f'index-{self.env.new_serialno("index")}'
         entries = [
@@ -277,11 +281,10 @@ class CWE(ReferenceRole):
         return [index, target, reference], []
 
     def build_uri(self) -> str:
-        base_url = self.inliner.document.settings.cwe_base_url
         ret = self.target.split('#', 1)
         if len(ret) == 2:
-            return f'{base_url}{int(ret[0])}.html#{ret[1]}'
-        return f'{base_url}{int(ret[0])}.html'
+            return f'{CWE._BASE_URL}{int(ret[0])}.html#{ret[1]}'
+        return f'{CWE._BASE_URL}{int(ret[0])}.html'
 
 
 class PEP(ReferenceRole):

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/texinputs/sphinx.sty

@@ -9,7 +9,7 @@
 % by the Sphinx LaTeX writer.
 
 \NeedsTeXFormat{LaTeX2e}[1995/12/01]
-\ProvidesPackage{sphinx}[2024/07/28 v8.1.0 Sphinx LaTeX package (sphinx-doc)]
+\ProvidesPackage{sphinx}[2024/10/11 v8.1.1 Sphinx LaTeX package (sphinx-doc)]
 
 % provides \ltx@ifundefined
 % (many packages load ltxcmds: graphicx does for pdftex and lualatex but
@@ -885,15 +885,12 @@
   {\DeclareStringOption[fontawesome]{iconpackage}}
   {\DeclareStringOption[none]{iconpackage}}%
 }%
-\newcommand\spx@faIcon[3][]{}%
-% The hacky definition of \spx@faIcon above is to let it by default swallow
-% the icon macro and the \sphinxtitlerowaftericonspacecmd (see
-% \sphinxdotitlerowwithicon in sphinxlatexadmonitions.sty) which inserts
-% a space between it and title.  See how \spx@faIcon is used below.
-%
-% If user sets a title-icon key to some LaTeX code of their own, of course
-% \spx@faIcon is not executed and the inserted space will thus be there, as
-% expected.
+\newcommand\spx@faIcon[2][]{}%
+% The above \spx@faIcon which gobbles one mandatory and one optional
+% argument is put into use only if both fontawesome5 and fontawesome
+% LaTeX packages are not available, as part of the defaults for the
+% div.*_title-icon keys (these keys can be redefined via the sphinxsetup
+% interface).
 %
 \def\spxstring@fontawesome{fontawesome}
 \def\spxstring@fontawesomev{fontawesome5}
@@ -920,8 +917,8 @@
                    \let\faicon@pen\faPencil
               \fi
           % if neither has been required, \spx@faIcon will simply swallow
-          % its argument (and follwing space macro) and it is up to user
-          % to set the keys appropriately.
+          % its argument and it is up to user
+          % to set the various div.*_title-icon keys appropriately.
           \fi\fi %
          }%
          {%

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/texinputs/sphinxlatexadmonitions.sty

@@ -1,7 +1,7 @@
 %% NOTICES AND ADMONITIONS
 %
 % change this info string if making any custom modification
-\ProvidesPackage{sphinxlatexadmonitions}[2024/07/28 v8.1.0 admonitions]
+\ProvidesPackage{sphinxlatexadmonitions}[2024/10/11 v8.1.1 admonitions]
 
 % Provides support for this output mark-up from Sphinx latex writer:
 %
@@ -341,9 +341,11 @@
          \ifdim\wd\z@>\z@
           \textcolor{sphinx#1TtlFgColor}{%
             \@nameuse{sphinx#1TtlIcon}%
-            % This macro is located here and not after the closing brace
-            % for reasons of fall-back \spx@faIcon definition in sphinx.sty
-            % in case fontawesome5 package not found.
+            % The next macro is located here for legacy reasons of earlier
+            % functioning of \spx@faIcon.  When fontawesome{5,}.sty both
+            % are unavailable, it (formerly) gobbled this next macro.
+            % We leave it here now although it could be moved to after
+            % the closing brace.
             \sphinxtitlerowaftericonspacecmd
           }%
          \fi

{sphinx-8.1.0 → sphinx-8.1.2}/sphinx/util/__init__.py

@@ -8,6 +8,7 @@ import posixpath
 import re
 from typing import Any
 
+from sphinx.errors import ExtensionError as _ExtensionError
 from sphinx.errors import FiletypeNotFoundError
 from sphinx.util import _files, _importer, logging
 from sphinx.util import index_entries as _index_entries
@@ -86,6 +87,7 @@ _DEPRECATED_OBJECTS: dict[str, tuple[Any, str, tuple[int, int]]] = {
         'sphinx.util.index_entries.split_into',
         (9, 0),
     ),
+    'ExtensionError': (_ExtensionError, 'sphinx.errors.ExtensionError', (9, 0)),
     'md5': (_md5, '', (9, 0)),
     'sha1': (_sha1, '', (9, 0)),
     'import_object': (_importer.import_object, '', (10, 0)),

{sphinx-8.1.0 → sphinx-8.1.2}/tests/test_markup/test_markup.py

@@ -166,14 +166,14 @@ def get_verifier(verify, verify_re):
             ':cve:`2020-10735`',
             (
                 '<p><span class="target" id="index-0"></span><a class="cve reference external" '
-                'href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735">'
+                'href="https://www.cve.org/CVERecord?id=CVE-2020-10735">'
                 '<strong>CVE 2020-10735</strong></a></p>'
             ),
             (
                 '\\sphinxAtStartPar\n'
                 '\\index{Common Vulnerabilities and Exposures@\\spxentry{Common Vulnerabilities and Exposures}'
                 '!CVE 2020\\sphinxhyphen{}10735@\\spxentry{CVE 2020\\sphinxhyphen{}10735}}'
-                '\\sphinxhref{https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735}'
+                '\\sphinxhref{https://www.cve.org/CVERecord?id=CVE-2020-10735}'
                 '{\\sphinxstylestrong{CVE 2020\\sphinxhyphen{}10735}}'
             ),
         ),
@@ -183,14 +183,14 @@ def get_verifier(verify, verify_re):
             ':cve:`2020-10735#id1`',
             (
                 '<p><span class="target" id="index-0"></span><a class="cve reference external" '
-                'href="https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735#id1">'
+                'href="https://www.cve.org/CVERecord?id=CVE-2020-10735#id1">'
                 '<strong>CVE 2020-10735#id1</strong></a></p>'
             ),
             (
                 '\\sphinxAtStartPar\n'
                 '\\index{Common Vulnerabilities and Exposures@\\spxentry{Common Vulnerabilities and Exposures}'
                 '!CVE 2020\\sphinxhyphen{}10735\\#id1@\\spxentry{CVE 2020\\sphinxhyphen{}10735\\#id1}}'
-                '\\sphinxhref{https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735\\#id1}'
+                '\\sphinxhref{https://www.cve.org/CVERecord?id=CVE-2020-10735\\#id1}'
                 '{\\sphinxstylestrong{CVE 2020\\sphinxhyphen{}10735\\#id1}}'
             ),
         ),

sphinx-8.1.0/doc/_static/diagrams/sphinx_build_flow.dot

@@ -1,48 +0,0 @@
-// UML for the standard Sphinx build workflow
-
-digraph build {
-    graph [
-        rankdir=LR
-    ];
-    node [
-        shape=rect
-        style=rounded
-    ];
-
-    "Sphinx" [
-        shape=record
-        label = "Sphinx | <init> __init__ | <build> build"
-    ];
-    "Sphinx":init -> "Builder.init";
-    "Sphinx":build -> "Builder.build_all";
-    "Sphinx":build -> "Builder.build_specific";
-    "Builder.build_update" [
-        shape=record
-        label = "<p1> Builder.build_update | Builder.get_outdated_docs"
-    ];
-    "Sphinx":build -> "Builder.build_update":p1 ;
-
-    "Builder.build_all" -> "Builder.build";
-    "Builder.build_specific" -> "Builder.build";
-    "Builder.build_update":p1 -> "Builder.build";
-
-    "Builder.build" -> "Builder.read";
-    "Builder.build" -> "Builder.write";
-    "Builder.build" -> "Builder.finish";
-
-    "Builder.read" -> "Builder.read_doc";
-    "Builder.read_doc" -> "Builder.write_doctree";
-
-    "Builder.write":p1 -> "Builder.prepare_writing";
-    "Builder.write":p1 -> "Builder.copy_assets";
-    "Builder.write_documents" [
-        shape=record
-        label = "<p1> Builder.write_documents | Builder._write_serial | Builder._write_parallel"
-    ];
-    "Builder.write":p1 -> "Builder.write_documents";
-
-    "Builder.write_documents":p1 -> "Builder.write_doc";
-    "Builder.write_doc" -> "Builder.get_relative_uri";
-
-    "Builder.get_relative_uri" -> "Builder.get_target_uri";
-}