Sphinx 8.1.2__tar.gz → 8.2.0__tar.gz

sphinx-8.2.0/AUTHORS.rst

@@ -0,0 +1,128 @@
+Maintainers
+===========
+
+*Listed alphabetically in forename, surname order*
+
+* Adam Turner <@AA-Turner>
+* Bénédikt Tran <@picnixz>
+* Chris Sewell <@chrisjsewell>
+* François Freitag <@francoisfreitag>
+* Jakob Lykke Andersen <@jakobandersen>
+* Jean-François B. <@jfbu>
+* Stephen Finucane <@stephenfin>
+* Takayuki Shimizukawa <@shimizukawa>
+* Takeshi Komiya <@tk0miya>
+
+Contributors
+============
+
+*Listed alphabetically in forename, surname order*
+
+* Aaron Carlisle -- basic theme and templating improvements
+* Adam Dangoor -- improved static typing
+* Adrián Chaves (Gallaecio) -- coverage builder improvements
+* Alastair Houghton -- Apple Help builder
+* Alex Gaynor -- linkcheck retry on errors
+* Alexander Todorov -- inheritance_diagram tests and improvements
+* Andi Albrecht -- agogo theme
+* Antonio Valentino -- qthelp builder, docstring inheritance
+* Antti Kaihola -- doctest extension (skipif option)
+* Barry Warsaw -- setup command improvements
+* Bart Kamphorst -- warning improvements
+* Ben Egan -- Napoleon improvements & viewcode improvements
+* Benjamin Peterson -- unittests
+* Blaise Laflamme -- pyramid theme
+* Brecht Machiels -- builder entry-points
+* Bruce Mitchener -- Minor epub improvement
+* Buck Evan -- dummy builder
+* Charles Duffy -- original graphviz extension
+* Chris Barrick -- Napoleon type preprocessing logic
+* Chris Holdgraf -- improved documentation structure
+* Chris Lamb -- reproducibility fixes
+* Christopher Perkins -- autosummary integration
+* Dan MacKinlay -- metadata fixes
+* Daniel Bültmann -- todo extension
+* Daniel Eades -- improved static typing
+* Daniel Hahler -- testing and CI improvements
+* Daniel Pizetta -- inheritance diagram improvements
+* Dave Kuhlman -- original LaTeX writer
+* Dimitri Papadopoulos Orfanos -- linting and spelling
+* Dmitry Shachnev -- modernisation and reproducibility
+* Doug Hellmann -- graphviz improvements
+* Eric Larson -- better error messages
+* Eric N. Vander Weele -- autodoc improvements
+* Eric Wieser -- autodoc improvements
+* Etienne Desautels -- apidoc module
+* Ezio Melotti -- collapsible sidebar JavaScript
+* Filip Vavera -- napoleon todo directive
+* Glenn Matthews -- python domain signature improvements
+* Gregory Szorc -- performance improvements
+* Henrique Bastos -- SVG support for graphviz extension
+* Hernan Grecco -- search improvements
+* Hong Xu -- svg support in imgmath extension and various bug fixes
+* Horst Gutmann -- internationalization support
+* Hugo van Kemenade -- support FORCE_COLOR and NO_COLOR
+* Ian Lee -- quickstart improvements
+* Jacob Mason -- websupport library (GSOC project)
+* James Addison -- linkcheck and HTML search improvements
+* Jeppe Pihl -- literalinclude improvements
+* Jeremy Maitin-Shepard -- C++ domain improvements
+* Joel Wurtz -- cellspanning support in LaTeX
+* John Waltman -- Texinfo builder
+* Jon Dufresne -- modernisation
+* Josip Dzolonga -- coverage builder
+* Juan Luis Cano Rodríguez -- new tutorial (2021)
+* Julien Palard -- Colspan and rowspan in text builder
+* Justus Magin -- napoleon improvements
+* Kevin Dunn -- MathJax extension
+* KINEBUCHI Tomohiko -- typing Sphinx as well as docutils
+* Kurt McKee -- documentation updates
+* Lars Hupfeldt Nielsen - OpenSSL FIPS mode md5 bug fix
+* Louis Maddox -- better docstrings
+* Łukasz Langa -- partial support for autodoc
+* Marco Buttu -- doctest extension (pyversion option)
+* Martin Hans -- autodoc improvements
+* Martin Larralde -- additional napoleon admonitions
+* Martin Liška -- option directive and role improvements
+* Martin Mahner -- nature theme
+* Matthew Fernandez -- todo extension fix
+* Matthew Woodcraft -- text output improvements
+* Matthias Geier -- style improvements
+* Michael Droettboom -- inheritance_diagram extension
+* Michael Wilson -- Intersphinx HTTP basic auth support
+* Nathan Damon -- bugfix in validation of static paths in html builders
+* Nils Kattenbeck -- pygments dark style
+* Pauli Virtanen -- autodoc improvements, autosummary extension
+* Rafael Fontenelle -- internationalisation
+* \A. Rafey Khan -- improved intersphinx typing
+* Roland Meister -- epub builder
+* Sebastian Wiesner -- image handling, distutils support
+* Slawek Figiel -- additional warning suppression
+* Stefan Seefeld -- toctree improvements
+* Stefan van der Walt -- autosummary extension
+* \T. Powers -- HTML output improvements
+* Taku Shimizu -- epub3 builder
+* Thomas Lamb -- linkcheck builder
+* Thomas Waldmann -- apidoc module fixes
+* Tim Hoffmann -- theme improvements
+* Vince Salvino -- JavaScript search improvements
+* Will Maier -- directory HTML builder
+* Zac Hatfield-Dodds -- doctest reporting improvements, intersphinx performance
+
+Former maintainers
+==================
+
+*Listed alphabetically in forename, surname order*
+
+Former maintainers are those who haven't committed in the last two years.
+Those on the list below may become active maintainers again at any time.
+
+* Armin Ronacher <@mitsuhiko>
+* Daniel Neuhäuser <@DasIch>
+* Georg Brandl <georg@python.org>
+* Rob Ruana <@RobRuana>
+* Robert Lehmann <@lehmannro>
+* Timotheus Kampik <@TimKam>
+* Yoshiki Shibukawa <@shibukawa>
+
+Many thanks for all contributions!

sphinx-8.2.0/CHANGES.rst

@@ -0,0 +1,167 @@
+Release 8.2.0 (released Feb 18, 2025)
+=====================================
+
+Dependencies
+------------
+
+* #13000: Drop Python 3.10 support.
+
+Incompatible changes
+--------------------
+
+* #13044: Remove the internal and undocumented ``has_equations`` data
+  from the :py:class:`!MathDomain` domain.
+  The undocumented :py:meth:`!MathDomain.has_equations` method
+  now unconditionally returns ``True``.
+  These are replaced by the ``has_maths_elements`` key of the page context dict.
+  Patch by Adam Turner.
+* #13227: HTML output for sequences of keys in the :rst:role:`kbd` role
+  no longer uses a ``<kbd class="kbd compound">`` element to wrap
+  the keys and separators, but places them directly in the relevant parent node.
+  This means that CSS rulesets targeting ``kbd.compound`` or ``.kbd.compound``
+  will no longer have any effect.
+  Patch by Adam Turner.
+
+Deprecated
+----------
+
+* #13037: Deprecate the ``SingleHTMLBuilder.fix_refuris`` method.
+  Patch by James Addison.
+* #13083, #13330: Un-deprecate ``sphinx.util.import_object``.
+  Patch by Matthias Geier.
+
+Features added
+--------------
+
+* #13173: Add a new ``duplicate_declaration`` warning type,
+  with ``duplicate_declaration.c`` and ``duplicate_declaration.cpp`` subtypes.
+  Patch by Julien Lecomte and Adam Turner.
+* #11824: linkcode: Allow extensions to add support for a domain by defining
+  the keys that should be present.
+  Patch by Nicolas Peugnet.
+* #13144: Add a ``class`` option to the :rst:dir:`autosummary` directive.
+  Patch by Tim Hoffmann.
+* #13146: Napoleon: Unify the type preprocessing logic to allow
+  Google-style docstrings to use the optional and default keywords.
+  Patch by Chris Barrick.
+* #13227: Implement the :rst:role:`kbd` role as a ``SphinxRole``.
+  Patch by Adam Turner.
+* #13065: Enable colour by default in when running on CI.
+  Patch by Adam Turner.
+* #13230: Allow supressing warnings from the :rst:dir:`toctree` directive
+  when a glob pattern doesn't match any documents,
+  via the new ``toc.empty_glob`` warning sub-type.
+  Patch by Slawek Figiel.
+* #9732: Add the new ``autodoc.mocked_object`` warnings sub-type.
+  Patch by Cyril Roelandt.
+* #7630, #4824: autodoc: Use :file:`.pyi` type stub files
+  to auto-document native modules.
+  Patch by Adam Turner, partially based on work by Allie Fitter.
+* #12975: Enable configuration of trailing commas in multi-line signatures
+  in the Python and Javascript domains, via the new
+  :confval:`python_trailing_comma_in_multi_line_signatures` and
+  :confval:`javascript_trailing_comma_in_multi_line_signatures`
+  configuration options.
+* #13264: Rename the :rst:dir:`math` directive's ``nowrap`` option
+  to :rst:dir:`math:no-wrap`.
+  Patch by Adam Turner.
+* #13269: Added the option to disable the use of type comments in
+  via the new :confval:`autodoc_use_type_comments` option,
+  which defaults to ``True`` for backwards compatibility.
+  The default will change to ``False`` in Sphinx 10.
+  Patch by Adam Turner.
+* #9732: Add the new ``ref.any`` warnings sub-type
+  to allow suppressing the ambiguous 'any' cross-reference warning.
+  Patch by Simão Afonso and Adam Turner.
+* #13272: The Python and JavaScript module directives now support
+  the ``:no-index-entry:`` option.
+  Patch by Adam Turner.
+* #12233: autodoc: Allow directives to use ``:no-index-entry:``
+  and include the ``:no-index:`` and ``:no-index-entry:`` options within
+  :confval:`autodoc_default_options`.
+  Patch by Jonny Saunders and Adam Turner.
+* #13172: Add support for short signatures in autosummary.
+  Patch by Tim Hoffmann.
+* #13271: Change the signature prefix for abstract methods
+  in the Python domain to *abstractmethod* from *abstract*.
+  Patch by Adam Turner.
+* #13271: Support the ``:abstract:`` option for
+  classes, methods, and properties in the Python domain.
+  Patch by Adam Turner.
+* #12507: Add the :ref:`collapsible <collapsible-admonitions>` option
+  to admonition directives.
+  Patch by Chris Sewell.
+* #8191, #8159: Add :rst:dir:`inheritance-diagram:include-subclasses` option to
+  the :rst:dir:`inheritance-diagram` directive.
+  Patch by Walter Dörwald.
+* #11995: autodoc: Add support for :confval:`python_display_short_literal_types`.
+  Patch by Bénédikt Tran and Adam Turner.
+* #13163: Always print the full context when Sphinx encounters an internal error.
+  Patch by Kevin Deldycke and Adam Turner.
+* #13105: Introduce the :rst:role:`py:deco` role to cross-reference decorator
+  functions and methods in the Python domain.
+  Patch by Adam Turner.
+* #9169: Add the :confval:`intersphinx_resolve_self` option
+  to resolve an intersphinx reference to the current project.
+  Patch by Jakob Lykke Andersen and Adam Turner.
+* #11280: Add ability to skip a particular section using the ``no-search`` class.
+  Patch by Will Lachance.
+* #13326: Remove hardcoding from handling :class:`~sphinx.addnodes.productionlist`
+  nodes in all writers, to improve flexibility.
+  Patch by Adam Turner.
+* #13335: Use ``misc.highlighting_failure`` subtype for Pygments unknown lexers.
+  Patch by Bart Kamphorst.
+* #13354: Insert abbreviation nodes (hover text) for positional- and keyword-only
+  separators in Python signatures.
+  Patch by Adam Turner.
+* #13333: Add the :mod:`sphinx.ext.apidoc` extension,
+  to automate API documentation generation from Python modules.
+  Patch by Chris Sewell and Adam Turner.
+
+Bugs fixed
+----------
+
+* #12463: autosummary: Respect an empty module ``__all__``.
+  Patch by Valentin Pratz
+* #13060: HTML Search: use ``Map`` to store per-file term scores.
+  Patch by James Addison
+* #13130: LaTeX docs: ``pdflatex`` index creation may fail for index entries
+  in French.  See :confval:`latex_use_xindy`.
+  Patch by Jean-François B.
+* #13152: LaTeX: fix a typo from v7.4.0 in a default for ``\sphinxboxsetup``.
+  Patch by Jean-François B.
+* #13096: HTML Search: check that query terms exist as properties in
+  term indices before accessing them.
+* #11233: linkcheck: match redirect URIs against :confval:`linkcheck_ignore` by
+  overriding session-level ``requests.get_redirect_target``.
+* #13195: viewcode: Fix issue where import paths differ from the directory
+  structure.
+  Patch by Ben Egan and Adam Turner.
+* #13188: autodoc: fix detection of class methods implemented in C.
+  Patch by Bénédikt Tran.
+* #1810: Always copy static files when building, regardless of whether
+  any documents have changed since the previous build.
+  Patch by Adam Turner.
+* #13201: autodoc: fix ordering of members when using ``groupwise``
+  for :confval:`autodoc_member_order`. Class methods are now rendered
+  before static methods, which themselves are rendered before regular
+  methods and attributes.
+  Patch by Bénédikt Tran.
+* #12975: Avoid rendering a trailing comma in C and C++ multi-line signatures.
+* #13178: autodoc: Fix resolution for ``pathlib`` types.
+  Patch by Adam Turner.
+* #13136: autodoc: Correctly handle multiple inheritance.
+  Patch by Pavel Holica
+* #13273, #13318: Properly convert command-line overrides for Boolean types.
+  Patch by Adam Turner.
+* #13302, #13319: Use the correct indentation for continuation lines
+  in :rst:dir:`productionlist` directives.
+  Patch by Adam Turner.
+* #13328: Fix parsing of PEP 695 functions with return annotations.
+  Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.
+
+Testing
+-------
+
+* #13224: Correctness fixup for ``test_html_multi_line_copyright``.
+  Patch by Colin Watson, applied by James Addison.

sphinx-8.2.0/LICENSE.rst

@@ -0,0 +1,31 @@
+License for Sphinx
+==================
+
+Unless otherwise indicated, all code in the Sphinx project is licenced under the
+two clause BSD licence below.
+
+Copyright (c) 2007-2025 by the Sphinx team (see AUTHORS file).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sphinx-8.2.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.3
+Name: Sphinx
+Version: 8.2.0
+Summary: Python documentation generator
+Author-email: Adam Turner <aa-turner@users.noreply.github.com>, Georg Brandl <georg@python.org>
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Other Audience
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Domain
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Framework :: Sphinx :: Theme
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Education
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management :: Link Checking
+Classifier: Topic :: Printing
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Editors :: Documentation
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Text Processing :: General
+Classifier: Topic :: Text Processing :: Indexing
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Text Processing :: Markup :: reStructuredText
+Classifier: Topic :: Text Processing :: Markup :: XML
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Dist: sphinxcontrib-applehelp>=1.0.7
+Requires-Dist: sphinxcontrib-devhelp>=1.0.6
+Requires-Dist: sphinxcontrib-htmlhelp>=2.0.6
+Requires-Dist: sphinxcontrib-jsmath>=1.0.1
+Requires-Dist: sphinxcontrib-qthelp>=1.0.6
+Requires-Dist: sphinxcontrib-serializinghtml>=1.1.9
+Requires-Dist: Jinja2>=3.1
+Requires-Dist: Pygments>=2.17
+Requires-Dist: docutils>=0.20,<0.22
+Requires-Dist: snowballstemmer>=2.2
+Requires-Dist: babel>=2.13
+Requires-Dist: alabaster>=0.7.14
+Requires-Dist: imagesize>=1.3
+Requires-Dist: requests>=2.30.0
+Requires-Dist: roman-numerals-py>=1.0.0
+Requires-Dist: packaging>=23.0
+Requires-Dist: colorama>=0.4.6; sys_platform == 'win32'
+Requires-Dist: sphinxcontrib-websupport ; extra == "docs"
+Requires-Dist: ruff==0.9.6 ; extra == "lint"
+Requires-Dist: mypy==1.15.0 ; extra == "lint"
+Requires-Dist: sphinx-lint>=0.9 ; extra == "lint"
+Requires-Dist: types-colorama==0.4.15.20240311 ; extra == "lint"
+Requires-Dist: types-defusedxml==0.7.0.20240218 ; extra == "lint"
+Requires-Dist: types-docutils==0.21.0.20241128 ; extra == "lint"
+Requires-Dist: types-Pillow==10.2.0.20240822 ; extra == "lint"
+Requires-Dist: types-Pygments==2.19.0.20250107 ; extra == "lint"
+Requires-Dist: types-requests==2.32.0.20241016 ; extra == "lint"
+Requires-Dist: types-urllib3==1.26.25.14 ; extra == "lint"
+Requires-Dist: pyright==1.1.394 ; extra == "lint"
+Requires-Dist: pytest>=8.0 ; extra == "lint"
+Requires-Dist: pypi-attestations==0.0.21 ; extra == "lint"
+Requires-Dist: betterproto==2.0.0b6 ; extra == "lint"
+Requires-Dist: pytest>=8.0 ; extra == "test"
+Requires-Dist: pytest-xdist[psutil]>=3.4 ; extra == "test"
+Requires-Dist: defusedxml>=0.7.1 ; extra == "test"
+Requires-Dist: cython>=3.0 ; extra == "test"
+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
+Provides-Extra: docs
+Provides-Extra: lint
+Provides-Extra: test
+
+========
+ Sphinx
+========
+
+.. image:: https://img.shields.io/pypi/v/sphinx.svg
+   :target: https://pypi.org/project/Sphinx/
+   :alt: Package on PyPI
+
+.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg
+   :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml
+   :alt: Build Status
+
+.. image:: https://readthedocs.org/projects/sphinx/badge/?version=master
+   :target: https://www.sphinx-doc.org/
+   :alt: Documentation Status
+
+.. image:: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg
+   :target: https://opensource.org/licenses/BSD-2-Clause
+   :alt: BSD 2 Clause
+
+**Sphinx makes it easy to create intelligent and beautiful documentation.**
+
+Sphinx uses reStructuredText as its markup language, and many of its strengths
+come from the power and straightforwardness of reStructuredText and its parsing
+and translating suite, the Docutils.
+
+Features
+========
+
+* **Output formats**: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
+* **Extensive cross-references**: semantic markup and automatic links
+  for functions, classes, glossary terms and similar pieces of information
+* **Hierarchical structure**: easy definition of a document tree, with automatic
+  links to siblings, parents and children
+* **Automatic indices**: general index as well as a module index
+* **Code highlighting**: automatic highlighting using the Pygments highlighter
+* **Templating**: Flexible HTML output using the Jinja 2 templating engine
+* **Extension ecosystem**: Many extensions are available, for example for
+  automatic function documentation or working with Jupyter notebooks.
+* **Language Support**: Python, C, C++, JavaScript, mathematics, and many other
+  languages through extensions.
+
+For more information, refer to `the documentation`_.
+
+Installation
+============
+
+The following command installs Sphinx from the `Python Package Index`_. You will
+need a working installation of Python and pip.
+
+.. code-block:: shell
+
+   pip install -U sphinx
+
+Contributing
+============
+
+We appreciate all contributions! Refer to `the contributors guide`_ for
+information.
+
+.. _the documentation: https://www.sphinx-doc.org/
+.. _the contributors guide: https://www.sphinx-doc.org/en/master/internals/contributing.html
+.. _Python Package Index: https://pypi.org/project/Sphinx/
+

sphinx-8.2.0/doc/_static/diagrams/sphinx_build_phases.dot

@@ -0,0 +1,18 @@
+digraph phases {
+
+    graph [
+        rankdir = LR
+    ]
+
+    node [
+        shape = rect;
+        style = filled;
+        fillcolor ="#f7f7f7";
+        fontcolor = "#0a507a"
+    ]
+
+    Initialization -> Reading;
+    Reading -> "Consistency checks";
+    "Consistency checks" -> Resolving;
+    Resolving -> Writing;
+}

sphinx-8.2.0/doc/_static/translation.svg

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="223px" preserveAspectRatio="none" style="width:637px;height:223px;" version="1.1" viewBox="0 0 637 223" width="637px" zoomAndPan="magnify"><defs><filter height="300%" id="fh7abla96c8rb" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><!--MD5=[631d54569d64dd7be7afb1602a233020]
+entity SphinxProject--><polygon fill="#FEFECE" filter="url(#fh7abla96c8rb)" points="6,30.5,6,66.7969,120,66.7969,120,40.5,110,30.5,6,30.5" style="stroke: #000000; stroke-width: 1.5;"/><path d="M110,30.5 L110,40.5 L120,40.5 " fill="#FEFECE" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="94" x="16" y="53.4951">SphinxProject</text><!--MD5=[61096c0d57626e43fed95496d4441932]
+entity .rst--><polygon fill="#FEFECE" filter="url(#fh7abla96c8rb)" points="155,30.5,155,66.7969,197,66.7969,197,40.5,187,30.5,155,30.5" style="stroke: #000000; stroke-width: 1.5;"/><path d="M187,30.5 L187,40.5 L197,40.5 " fill="#FEFECE" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="22" x="165" y="53.4951">.rst</text><!--MD5=[08ed079d9b091f9ed2d220f9f6abc033]
+entity .pot--><path d="M359.5,36 C359.5,26 383,26 383,26 C383,26 406.5,26 406.5,36 L406.5,61.2969 C406.5,71.2969 383,71.2969 383,71.2969 C383,71.2969 359.5,71.2969 359.5,61.2969 L359.5,36 " fill="#FEFECE" filter="url(#fh7abla96c8rb)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M359.5,36 C359.5,46 383,46 383,46 C383,46 406.5,46 406.5,36 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="27" x="369.5" y="62.9951">.pot</text><!--MD5=[66eca29884632d3929c321eae20b9288]
+entity .po--><path d="M483,36 C483,26 504,26 504,26 C504,26 525,26 525,36 L525,61.2969 C525,71.2969 504,71.2969 504,71.2969 C504,71.2969 483,71.2969 483,61.2969 L483,36 " fill="#FEFECE" filter="url(#fh7abla96c8rb)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M483,36 C483,46 504,46 504,46 C504,46 525,46 525,36 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="22" x="493" y="62.9951">.po</text><!--MD5=[fad5092d1b513ed9e4cd2391fb0fb212]
+entity .mo--><path d="M398,176 C398,166 421,166 421,166 C421,166 444,166 444,176 L444,201.2969 C444,211.2969 421,211.2969 421,211.2969 C421,211.2969 398,211.2969 398,201.2969 L398,176 " fill="#FEFECE" filter="url(#fh7abla96c8rb)" style="stroke: #000000; stroke-width: 1.5;"/><path d="M398,176 C398,186 421,186 421,186 C421,186 444,186 444,176 " fill="none" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="26" x="408" y="202.9951">.mo</text><!--MD5=[8f276d451ff344d4b5b89d896332ffcd]
+entity translator--><ellipse cx="593" cy="17.5" fill="#FEFECE" filter="url(#fh7abla96c8rb)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 1.5;"/><path d="M593,25.5 L593,52.5 M580,33.5 L606,33.5 M593,52.5 L580,67.5 M593,52.5 L606,67.5 " fill="none" filter="url(#fh7abla96c8rb)" style="stroke: #A80036; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="65" x="560.5" y="85.9951">translator</text><!--MD5=[ba0f3816bcb6df458d88626e193b44ee]
+entity TranslatedBuild--><polygon fill="#FEFECE" filter="url(#fh7abla96c8rb)" points="214.5,170.5,214.5,206.7969,341.5,206.7969,341.5,180.5,331.5,170.5,214.5,170.5" style="stroke: #000000; stroke-width: 1.5;"/><path d="M331.5,170.5 L331.5,180.5 L341.5,180.5 " fill="#FEFECE" style="stroke: #000000; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="107" x="224.5" y="193.4951">TranslatedBuild</text><!--MD5=[2a0f0d8c54238b3eb600ae284aca39d2]
+reverse link .po to translator--><path d="M530.44,48.5 C540.43,48.5 550.43,48.5 560.43,48.5 " fill="none" id=".po&lt;-translator" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="525.21,48.5,534.21,52.5,530.21,48.5,534.21,44.5,525.21,48.5" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[25ad71f3d3609323ec521914d1dc498d]
+link SphinxProject to .rst--><path d="M120.38,48.5 C130.13,48.5 139.87,48.5 149.61,48.5 " fill="none" id="SphinxProject-&gt;.rst" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="154.71,48.5,145.71,44.5,149.71,48.5,145.71,52.5,154.71,48.5" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[1109e8764a7297dc8aca732b1794aa90]
+link .rst to .pot--><path d="M197.37,48.5 C234.72,48.5 311.88,48.5 354,48.5 " fill="none" id=".rst-&gt;.pot" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="359.21,48.5,350.21,44.5,354.21,48.5,350.21,52.5,359.21,48.5" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="126" x="215.25" y="41.5669">sphinx-build gettext</text><!--MD5=[c2d0ba229470f335ea07ab2ed6b28ec0]
+link .pot to .po--><path d="M406.62,48.5 C427.03,48.5 456.51,48.5 477.68,48.5 " fill="none" id=".pot-&gt;.po" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="482.87,48.5,473.87,44.5,477.87,48.5,473.87,52.5,482.87,48.5" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="40" x="424.75" y="41.5669">Pootle</text><!--MD5=[06651b5914fbf4764a077bbac7efe19a]
+link .po to .mo--><path d="M491.03,71.06 C476.38,95.43 452.52,135.09 436.8,161.24 " fill="none" id=".po-&gt;.mo" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="434.15,165.63,442.2104,159.9705,436.7225,161.3425,435.3505,155.8546,434.15,165.63" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="50" x="462" y="132.0669">msgfmt</text><!--MD5=[02fa75427086f2cebad4a5f1b2dd96dd]
+reverse link TranslatedBuild to .mo--><path d="M346.94,188.5 C363.88,188.5 380.82,188.5 397.76,188.5 " fill="none" id="TranslatedBuild&lt;-.mo" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="341.68,188.5,350.68,192.5,346.68,188.5,350.68,184.5,341.68,188.5" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[e72b6258a50343d4926d984a36170cf2]
+link .rst to TranslatedBuild--><path d="M188.71,66.7 C207.27,91.8 241.75,138.46 262,165.86 " fill="none" id=".rst-&gt;TranslatedBuild" style="stroke: #A80036; stroke-width: 1.0;"/><polygon fill="#A80036" points="265.13,170.08,262.9905,160.4663,262.1552,166.0612,256.5604,165.226,265.13,170.08" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="165" x="241" y="132.0669">sphinx-build -Dlanguage=</text><!--MD5=[30dba34f254541587149d90abdb00688]
+@startuml
+file "SphinxProject"
+file ".rst"
+database ".pot"
+database ".po"
+database ".mo"
+actor translator
+file TranslatedBuild
+translator -l-> .po
+SphinxProject -r-> .rst
+.rst -r-> .pot : sphinx-build gettext
+.pot -r-> .po : Pootle
+.po -d-> .mo : msgfmt
+.mo -l-> TranslatedBuild
+.rst -d-> TranslatedBuild : "sphinx-build -Dlanguage="
+@enduml
+
+PlantUML version 1.2020.00(Sat Jan 11 12:30:53 GMT 2020)
+(GPL source distribution)
+Java Runtime: OpenJDK Runtime Environment
+JVM: OpenJDK 64-Bit Server VM
+Java Version: 1.8.0_252-b09
+Operating System: Linux
+Default Encoding: UTF-8
+Language: en
+Country: null
+--></g></svg>