Sphinx 9.0.0rc4__tar.gz

sphinx-9.0.0rc4/AUTHORS.rst

@@ -0,0 +1,141 @@
+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 Hoese -- ``sphinx.ext.viewcode`` and ``sphinx.ext.apidoc`` bug fixes
+* 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
+* Erik Bedard -- config options for :mod:`sphinx.ext.duration`
+* Etienne Desautels -- apidoc module
+* Ezio Melotti -- collapsible sidebar JavaScript
+* Filip Vavera -- napoleon todo directive
+* Florian Best -- log improvements
+* 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 Hunt-Isaak -- typealias reference improvement
+* 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
+* Kazuya Take -- ``sphinx.testing.path`` bug fix
+* 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)
+* Mark Ostroth -- semantic HTML contributions
+* Martin Hans -- autodoc improvements
+* Martin Larralde -- additional napoleon admonitions
+* Martin Liška -- option directive and role improvements
+* Martin Mahner -- nature theme
+* Martin Matouš -- initial support for PEP 695
+* 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
+* Rui Pinheiro -- Python 3.14 forward references support
+* 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
+* Steve Piercy -- documentation improvements
+* Szymon Karpinski -- intersphinx improvements
+* \T. Powers -- HTML output improvements
+* Taku Shimizu -- epub3 builder
+* Tamika Nomara -- bug fixes
+* Thomas Lamb -- linkcheck builder
+* Thomas Waldmann -- apidoc module fixes
+* Till Hoffmann -- doctest option to exit after first failed test
+* Tim Hoffmann -- theme improvements
+* Victor Wheeler -- documentation 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-9.0.0rc4/CHANGES.rst

@@ -0,0 +1,199 @@
+Release 9.0.0 (in development)
+==============================
+
+Dependencies
+------------
+
+* #13786: Support `Docutils 0.22`_. Patch by Adam Turner.
+
+  .. _Docutils 0.22: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29
+
+Incompatible changes
+--------------------
+
+* #13639: :py:meth:`!SphinxComponentRegistry.create_source_parser` no longer
+  has an *app* parameter, instead taking *config* and *env*.
+  Patch by Adam Turner.
+* #13751, #14089: :mod:`sphinx.ext.autodoc` has been substantially rewritten,
+  and there may be some incompatible changes in edge cases, especially when
+  extensions interact with autodoc internals.
+  The :confval:`autodoc_use_legacy_class_based` option has been added to
+  use the legacy (pre-9.0) implementation of autodoc.
+  Patches by Adam Turner.
+* #13355: Don't include escaped title content in the search index.
+  Patch by Will Lachance.
+
+Deprecated
+----------
+
+* 13627: Deprecate remaining public :py:attr:`!.app` attributes,
+  including ``builder.app``, ``env.app``, ``events.app``,
+  and ``SphinxTransform.app``.
+  Patch by Adam Turner.
+* #13637: Deprecate the :py:meth:`!set_application` method
+  of :py:class:`~sphinx.parsers.Parser` objects.
+  Patch by Adam Turner.
+* #13644: Deprecate the :py:attr:`!Parser.config` and :py:attr:`!env` attributes.
+  Patch by Adam Turner.
+* #13665: Deprecate support for non-UTF 8 source encodings,
+  scheduled for removal in Sphinx 10.
+  Patch by Adam Turner.
+* #13679: Non-decodable characters in source files will raise an error in Sphinx 9.
+  Currently, such bytes are replaced with '?' along with logging a warning.
+  Patch by Adam Turner.
+* #13682: Deprecate :py:mod:`!sphinx.io`.
+  Sphinx no longer uses the :py:mod:`!sphinx.io` classes,
+  having replaced them with standard Python I/O.
+  The entire :py:mod:`!sphinx.io` module will be removed in Sphinx 10.
+  Patch by Adam Turner.
+* #13631: :func:`!sphinx.environment.adapters.toctree.global_toctree_for_doc`
+  and :meth:`!sphinx.environment.BuildEnvironment.get_and_resolve_doctree`
+  will require a *tags* keyword argument from Sphinx 11.
+  It may optionally be passed from Sphinx 9 onwards.
+  Patch by Adam Turner.
+
+Features added
+--------------
+
+* #13332: Add :confval:`doctest_fail_fast` option to exit after the first failed
+  test.
+  Patch by Till Hoffmann.
+* #13439: linkcheck: Permit warning on every redirect with
+  ``linkcheck_allowed_redirects = {}``.
+  Patch by Adam Turner and James Addison.
+* #13497: Support C domain objects in the table of contents.
+* #13500: LaTeX: add support for ``fontawesome6`` package.
+  Patch by Jean-François B.
+* #13509: autodoc: Detect :py:func:`typing_extensions.overload <typing.overload>`
+  and :py:func:`~typing.final` decorators.
+  Patch by Spencer Brown.
+* #13535: html search: Update to the latest version of Snowball (v3.0.1).
+  Patch by Adam Turner.
+* #13647: LaTeX: allow more cases of table nesting.
+  Patch by Jean-François B.
+* #13657: LaTeX: support CSS3 length units.
+  Patch by Jean-François B.
+* #13684: intersphinx: Add a file-based cache for remote inventories.
+  The location of the cache directory must not be relied upon externally,
+  as it may change without notice or warning in future releases.
+  Patch by Adam Turner.
+* #13805: LaTeX: add support for ``fontawesome7`` package.
+  Patch by Jean-François B.
+* #13508: autodoc: Initial support for :pep:`695` type aliases.
+  Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner.
+* #14023: Add the new :confval:`mathjax_config_path` option
+  to load MathJax configuration from a file.
+  Patch by Randolf Scholz and Adam Turner.
+* #14046: linkcheck: Add the :confval:`linkcheck_case_insensitive_urls` option
+  to allow case-insensitive URL comparison for specific URL patterns.
+  This is useful for links to websites that normalise URL casing (e.g. GitHub)
+  or case-insensitive servers.
+  Patch by Fazeel Usmani and James Addison.
+* #14075: autosummary: Provide more context in import exception stack traces.
+  Patch by Philipp A.
+* #13468: Add config options to :mod:`sphinx.ext.duration`.
+  Patch by Erik Bedard and Adam Turner.
+* #14022: Use MathJax v4 by default in the :mod:`sphinx.ext.mathjax` extension,
+  from v3 previously.
+  To keep using an older version, set the :confval:`mathjax_path` option.
+  Also add the new :confval:`mathjax4_config` option to configure MathJax v4.
+  Note that MathJax v3 is mostly compatible with MathJax v4, so existing
+  :confval:`mathjax3_config` settings should not need to change.
+  Patch by Matthias Geier.
+* #14029: intersphinx: Fix error in format string interpolation.
+  Patch by Matthieu de Cibeins.
+
+Bugs fixed
+----------
+
+* #13926: multiple py:type directives for the same canonical type no
+  longer result in spurious duplicate object description warnings.
+  Patch by Jeremy Maitin-Shepard.
+* #1327: LaTeX: tables using longtable raise error if
+  :rst:dir:`tabularcolumns` specifies automatic widths
+  (``L``, ``R``, ``C``, or ``J``).
+  Patch by Jean-François B.
+* #3447: LaTeX: when assigning longtable class to table for PDF, it may render
+  "horizontally" and overflow in right margin.
+  Patch by Jean-François B.
+* #8828: LaTeX: adding a footnote to a longtable cell causes table to occupy
+  full width.
+  Patch by Jean-François B.
+* #11498: LaTeX: Table in cell fails to build if it has many rows.
+  Patch by Jean-François B.
+* #11515: LaTeX: longtable does not allow nested table.
+  Patch by Jean-François B.
+* #11973: LaTeX: links in table captions do not work in PDF.
+  Patch by Jean-François B.
+* #12821: LaTeX: URLs/links in section titles should render in PDF.
+  Patch by Jean-François B.
+* #13369: Correctly parse and cross-reference unpacked type annotations.
+  Patch by Alicia Garcia-Raboso.
+* #13528: Add tilde ``~`` prefix support for :rst:role:`py:deco`.
+  Patch by Shengyu Zhang and Adam Turner.
+* #13597: LaTeX: table nested in a merged cell leads to invalid LaTeX mark-up
+  and PDF cannot be built.
+  Patch by Jean-François B.
+* #13619: LaTeX: possible duplicated footnotes in PDF from object signatures
+  (typically if :confval:`latex_show_urls` ``= 'footnote'``).
+  Patch by Jean-François B.
+* #13635: LaTeX: if a cell contains a table, row coloring is turned off for
+  the next table cells.
+  Patch by Jean-François B.
+* #13685: gettext: Correctly ignore trailing backslashes.
+  Patch by Bénédikt Tran.
+* #13712: intersphinx: Don't add "v" prefix to non-numeric versions.
+  Patch by Szymon Karpinski.
+* #13688: HTML builder: Replace ``<em class="property">`` with
+  ``<span class="property">`` for attribute type annotations
+  to improve `semantic HTML structure
+  <https://html.spec.whatwg.org/multipage/text-level-semantics.html>`__.
+  Patch by Mark Ostroth.
+* #13812 (discussion): LaTeX: long :rst:dir:`confval` value does not wrap at
+  spaces in PDF.
+  Patch by Jean-François B.
+* #10785: Autodoc: Allow type aliases defined in the project to be properly
+  cross-referenced when used as type annotations. This makes it possible
+  for objects documented as ``:py:data:`` to be hyperlinked in function signatures.
+* #13858: doctest: doctest blocks are now correctly added to a group defined by the
+  configuration variable ``doctest_test_doctest_blocks``.
+* #13885: Coverage builder: Fix TypeError when warning about missing modules.
+  Patch by Damien Ayers.
+* #13929: Duplicate equation label warnings now have a new warning
+  sub-type, ``ref.equation``.
+  Patch by Jared Dillard.
+* #13935: autoclass: parent class members no longer considered
+  directly defined in certain cases, depending on autodoc processing
+  order.
+  Patch by Jeremy Maitin-Shepard.
+* #13939: LaTeX: page break can separate admonition title from contents.
+  Patch by Jean-François B.
+* #14004: Fix :confval:`autodoc_type_aliases` when they appear in PEP 604
+  union syntax (``Alias | Type``).
+  Patch by Tamika Nomara.
+* #14059: LaTeX: Footnotes cause pdflatex error with French language
+  (since late June 2025 upstream change to LaTeX ``babel-french``).
+  Patch by Jean-François B.
+* #13916: HTML Search: do not clear text fragments from the URL on page load.
+  Patch by Harmen Stoppels.
+* #13944: autodoc: show traceback during import in human readable representation.
+  Patch by Florian Best.
+* #14006: Support images with data URIs that aren't base64-encoded.
+  Patch by Shengyu Zhang and Adam Turner.
+* #12797: Fix ``Some type variables (...) are not listed in Generic[...]``
+  TypeError when inheriting from both Generic and autodoc mocked class.
+  Patch by Ikor Jefocur and Daniel Sperber.
+* #13945: autodoc: Fix handling of undefined names in annotations by using
+  the ``FORWARDREF`` :mod:`annotationlib` format.
+  Patch by Rui Pinheiro and Adam Turner.
+* #14067: EPUB: unify path separators in manifest items to forward slashes;
+  resolve duplicates in the manifest on Windows.
+  Patch by Akihiro Takizawa.
+* #13741: text builder: fix an infinite loop when processing CSV tables.
+  Patch by Bénédikt Tran.
+* #13217: Remove extra parentheses from :rst:dir:`js:function` arguments and errors.
+  Patch by Shengyu Zhang.
+
+
+Testing
+-------

sphinx-9.0.0rc4/CODE_OF_CONDUCT.rst

@@ -0,0 +1,78 @@
+======================
+Sphinx Code of Conduct
+======================
+
+Like the technical community as a whole, the Sphinx team and community is made
+up of volunteers from all over the world.
+Diversity is a strength, but it can also lead to communication issues and
+unhappiness. To that end, we have a few ground rules that we ask people to
+adhere to.
+
+* **Be friendly and patient.**
+
+* **Be welcoming.**
+  We strive to be a community that welcomes and supports people of all
+  backgrounds and identities. This includes, but is not limited to members of
+  any race, ethnicity, culture, national origin, colour, immigration status,
+  social and economic class, educational level, sex, sexual orientation, gender
+  identity and expression, age, size, family status, political belief, religion,
+  and mental and physical ability.
+
+* **Be considerate.**
+  Your work will be used by other people, and you in turn will depend on the
+  work of others. Any decision you take will affect users and colleagues, and
+  you should take those consequences into account when making decisions.
+  Remember that we're a world-wide community, so you might not be communicating
+  in someone else's primary language.
+
+* **Be respectful.**
+  Not all of us will agree all the time, but disagreement is no excuse for poor
+  behavior and poor manners. We might all experience some frustration now and
+  then, but we cannot allow that frustration to turn into a personal attack.
+  It's important to remember that a community where people feel uncomfortable or
+  threatened is not a productive one. Members of the Sphinx community should be
+  respectful when dealing with other members as well as with people outside the
+  Sphinx community.
+
+* **Be careful in the words that you choose.**
+  We are a community of professionals, and we conduct ourselves professionally.
+  Be kind to others. Do not insult or put down other participants. Harassment
+  and other exclusionary behavior aren't acceptable. This includes, but is not
+  limited to:
+
+  * Violent threats or language directed against another person.
+
+  * Discriminatory jokes and language.
+
+  * Posting sexually explicit or violent material.
+
+  * Posting (or threatening to post) other people's personally identifying
+    information ("doxing").
+
+  * Personal insults, especially those using racist or sexist terms.
+
+  * Unwelcome sexual attention.
+
+  * Advocating for, or encouraging, any of the above behavior.
+
+  * Repeated harassment of others. In general, if someone asks you to stop, then
+    stop.
+
+* **When we disagree, try to understand why.**
+  Disagreements, both social and technical, happen all the time and Sphinx is no
+  exception. It is important that we resolve disagreements and differing views
+  constructively. Remember that we're different. Different people have different
+  perspectives on issues. Being unable to understand why someone holds a
+  viewpoint doesn't mean that they're wrong. Don't forget that it is human to
+  err and blaming each other doesn't get us anywhere. Instead, focus on helping
+  to resolve issues and learning from mistakes.
+
+This isn't an exhaustive list of things that you can't do.
+Rather, take it in the spirit in which it's intended - a guide to make it easier
+to enrich all of us and the technical communities in which we participate.
+This code of conduct applies to all spaces of the Sphinx community.
+
+.. rubric:: Attribution
+
+Original text courtesy of the Speak Up! project:
+http://web.archive.org/web/20141109123859/http://speakup.io/coc.html.