From ffcb4b87846b4e4a2d9eee8df4b7ec40365878b8 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 5 Jun 2024 18:20:58 +0200 Subject: Merging upstream version 7.3.7. Signed-off-by: Daniel Baumann --- AUTHORS | 95 - AUTHORS.rst | 106 + CHANGES | 9019 ------------------- CHANGES.rst | 9299 ++++++++++++++++++++ CODE_OF_CONDUCT | 78 - CODE_OF_CONDUCT.rst | 78 + EXAMPLES | 479 - EXAMPLES.rst | 469 + LICENSE | 67 - LICENSE.rst | 67 + PKG-INFO | 26 +- README.rst | 2 +- doc/_static/tutorial/lumache-autosummary.png | Bin 26500 -> 20729 bytes doc/_static/tutorial/lumache-first-light.png | Bin 52126 -> 35872 bytes doc/_static/tutorial/lumache-furo.png | Bin 51223 -> 40306 bytes doc/_static/tutorial/lumache-py-function-full.png | Bin 71741 -> 56998 bytes doc/_static/tutorial/lumache-py-function.png | Bin 41828 -> 33130 bytes doc/_themes/sphinx13/layout.html | 11 +- doc/_themes/sphinx13/static/sphinx-logo.svg | 4 + doc/_themes/sphinx13/static/sphinx13.css | 25 +- doc/_themes/sphinx13/static/sphinxheader.png | Bin 11719 -> 0 bytes doc/_themes/sphinx13/theme.conf | 4 - doc/_themes/sphinx13/theme.toml | 4 + doc/authors.rst | 2 +- doc/changes.rst | 4 +- doc/conf.py | 156 +- doc/development/builders.rst | 18 +- doc/development/templating.rst | 5 +- doc/development/theming.rst | 125 +- .../tutorials/examples/autodoc_intenum.py | 19 +- doc/development/tutorials/examples/helloworld.py | 8 +- doc/development/tutorials/examples/recipe.py | 46 +- doc/development/tutorials/examples/todo.py | 34 +- doc/development/tutorials/recipe.rst | 6 +- doc/examples.rst | 2 +- doc/extdev/appapi.rst | 3 + doc/extdev/deprecated.rst | 14 + doc/extdev/i18n.rst | 4 +- doc/extdev/nodes.rst | 2 +- doc/extdev/utils.rst | 6 + doc/faq.rst | 2 +- doc/glossary.rst | 2 +- doc/index.rst | 2 +- doc/internals/code-of-conduct.rst | 2 +- doc/internals/contributing.rst | 12 +- doc/internals/organization.rst | 2 +- doc/internals/release-process.rst | 4 +- doc/latex.rst | 4 +- doc/man/sphinx-build.rst | 191 +- doc/man/sphinx-quickstart.rst | 3 + doc/support.rst | 2 +- doc/tutorial/automatic-doc-generation.rst | 2 +- doc/tutorial/deploying.rst | 15 +- doc/tutorial/describing-code.rst | 12 +- doc/tutorial/getting-started.rst | 2 +- doc/usage/advanced/intl.rst | 2 +- doc/usage/advanced/websupport/quickstart.rst | 4 +- doc/usage/advanced/websupport/searchadapters.rst | 2 +- doc/usage/advanced/websupport/storagebackends.rst | 2 +- doc/usage/builders/index.rst | 71 +- doc/usage/configuration.rst | 124 +- doc/usage/domains/c.rst | 367 + doc/usage/domains/cpp.rst | 760 ++ doc/usage/domains/index.rst | 208 + doc/usage/domains/javascript.rst | 132 + doc/usage/domains/mathematics.rst | 22 + doc/usage/domains/python.rst | 688 ++ doc/usage/domains/restructuredtext.rst | 99 + doc/usage/domains/standard.rst | 95 + doc/usage/extensions/autodoc.rst | 2 +- doc/usage/extensions/coverage.rst | 6 +- doc/usage/extensions/example_google.py | 1 + doc/usage/extensions/example_numpy.py | 6 +- doc/usage/extensions/graphviz.rst | 2 +- doc/usage/extensions/intersphinx.rst | 1 + doc/usage/extensions/math.rst | 4 +- doc/usage/extensions/napoleon.rst | 8 +- doc/usage/index.rst | 2 + doc/usage/installation.rst | 6 +- doc/usage/quickstart.rst | 10 +- doc/usage/referencing.rst | 258 + doc/usage/restructuredtext/basics.rst | 2 +- doc/usage/restructuredtext/directives.rst | 28 +- doc/usage/restructuredtext/domains.rst | 2563 +----- doc/usage/restructuredtext/field-lists.rst | 2 +- doc/usage/restructuredtext/index.rst | 4 + doc/usage/restructuredtext/roles.rst | 282 +- doc/usage/theming.rst | 6 +- pyproject.toml | 397 +- sphinx/__init__.py | 17 +- sphinx/addnodes.py | 59 +- sphinx/application.py | 24 +- sphinx/builders/__init__.py | 11 +- sphinx/builders/_epub_base.py | 26 +- sphinx/builders/changes.py | 15 +- sphinx/builders/dirhtml.py | 6 +- sphinx/builders/dummy.py | 5 +- sphinx/builders/epub3.py | 8 +- sphinx/builders/gettext.py | 31 +- sphinx/builders/html/__init__.py | 184 +- sphinx/builders/html/_assets.py | 32 +- sphinx/builders/html/transforms.py | 6 +- sphinx/builders/latex/__init__.py | 73 +- sphinx/builders/latex/nodes.py | 8 +- sphinx/builders/latex/transforms.py | 25 +- sphinx/builders/latex/util.py | 2 +- sphinx/builders/linkcheck.py | 113 +- sphinx/builders/manpage.py | 14 +- sphinx/builders/singlehtml.py | 9 +- sphinx/builders/texinfo.py | 32 +- sphinx/builders/text.py | 5 +- sphinx/builders/xml.py | 7 +- sphinx/cmd/build.py | 195 +- sphinx/cmd/make_mode.py | 13 +- sphinx/cmd/quickstart.py | 29 +- sphinx/config.py | 692 +- sphinx/deprecation.py | 36 +- sphinx/directives/__init__.py | 16 +- sphinx/directives/code.py | 14 +- sphinx/directives/other.py | 36 +- sphinx/directives/patches.py | 13 +- sphinx/domains/__init__.py | 4 +- sphinx/domains/c.py | 3906 -------- sphinx/domains/c/__init__.py | 849 ++ sphinx/domains/c/_ast.py | 1421 +++ sphinx/domains/c/_ids.py | 65 + sphinx/domains/c/_parser.py | 1048 +++ sphinx/domains/c/_symbol.py | 700 ++ sphinx/domains/changeset.py | 18 +- sphinx/domains/citation.py | 7 +- sphinx/domains/cpp.py | 8233 ----------------- sphinx/domains/cpp/__init__.py | 1181 +++ sphinx/domains/cpp/_ast.py | 3635 ++++++++ sphinx/domains/cpp/_ids.py | 537 ++ sphinx/domains/cpp/_parser.py | 2117 +++++ sphinx/domains/cpp/_symbol.py | 1092 +++ sphinx/domains/index.py | 10 +- sphinx/domains/javascript.py | 29 +- sphinx/domains/math.py | 13 +- sphinx/domains/python.py | 1769 ---- sphinx/domains/python/__init__.py | 904 ++ sphinx/domains/python/_annotations.py | 507 ++ sphinx/domains/python/_object.py | 426 + sphinx/domains/rst.py | 19 +- sphinx/domains/std.py | 1123 --- sphinx/domains/std/__init__.py | 1126 +++ sphinx/environment/__init__.py | 40 +- sphinx/environment/adapters/indexentries.py | 4 +- sphinx/environment/adapters/toctree.py | 19 +- sphinx/environment/collectors/__init__.py | 9 +- sphinx/environment/collectors/asset.py | 7 +- sphinx/environment/collectors/dependencies.py | 5 +- sphinx/environment/collectors/metadata.py | 11 +- sphinx/environment/collectors/title.py | 5 +- sphinx/environment/collectors/toctree.py | 9 +- sphinx/errors.py | 15 +- sphinx/events.py | 23 +- sphinx/ext/apidoc.py | 20 +- sphinx/ext/autodoc/__init__.py | 176 +- sphinx/ext/autodoc/directive.py | 13 +- sphinx/ext/autodoc/importer.py | 138 +- sphinx/ext/autodoc/mock.py | 12 +- sphinx/ext/autodoc/preserve_defaults.py | 7 +- sphinx/ext/autodoc/type_comment.py | 3 +- sphinx/ext/autodoc/typehints.py | 9 +- sphinx/ext/autosectionlabel.py | 5 +- sphinx/ext/autosummary/__init__.py | 38 +- sphinx/ext/autosummary/generate.py | 18 +- sphinx/ext/coverage.py | 46 +- sphinx/ext/doctest.py | 71 +- sphinx/ext/duration.py | 1 + sphinx/ext/extlinks.py | 7 +- sphinx/ext/githubpages.py | 5 +- sphinx/ext/graphviz.py | 17 +- sphinx/ext/ifconfig.py | 10 +- sphinx/ext/imgconverter.py | 11 +- sphinx/ext/imgmath.py | 17 +- sphinx/ext/inheritance_diagram.py | 62 +- sphinx/ext/intersphinx.py | 163 +- sphinx/ext/linkcode.py | 5 +- sphinx/ext/mathjax.py | 3 +- sphinx/ext/napoleon/__init__.py | 19 +- sphinx/ext/napoleon/docstring.py | 66 +- sphinx/ext/todo.py | 17 +- sphinx/ext/viewcode.py | 23 +- sphinx/extension.py | 26 +- sphinx/highlighting.py | 59 +- sphinx/io.py | 25 +- sphinx/jinja2glue.py | 31 +- sphinx/locale/__init__.py | 53 +- sphinx/locale/ar/LC_MESSAGES/sphinx.mo | Bin 7494 -> 7421 bytes sphinx/locale/ar/LC_MESSAGES/sphinx.po | 1579 ++-- sphinx/locale/bg/LC_MESSAGES/sphinx.mo | Bin 492 -> 492 bytes sphinx/locale/bg/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/bn/LC_MESSAGES/sphinx.mo | Bin 7591 -> 7519 bytes sphinx/locale/bn/LC_MESSAGES/sphinx.po | 1613 ++-- sphinx/locale/ca/LC_MESSAGES/sphinx.mo | Bin 84364 -> 86082 bytes sphinx/locale/ca/LC_MESSAGES/sphinx.po | 1671 ++-- sphinx/locale/cak/LC_MESSAGES/sphinx.mo | Bin 2391 -> 2391 bytes sphinx/locale/cak/LC_MESSAGES/sphinx.po | 1575 ++-- sphinx/locale/cs/LC_MESSAGES/sphinx.mo | Bin 7797 -> 7745 bytes sphinx/locale/cs/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/cy/LC_MESSAGES/sphinx.mo | Bin 5686 -> 5631 bytes sphinx/locale/cy/LC_MESSAGES/sphinx.po | 1581 ++-- sphinx/locale/da/LC_MESSAGES/sphinx.mo | Bin 12266 -> 12137 bytes sphinx/locale/da/LC_MESSAGES/sphinx.po | 1619 ++-- sphinx/locale/de/LC_MESSAGES/sphinx.mo | Bin 10680 -> 10544 bytes sphinx/locale/de/LC_MESSAGES/sphinx.po | 1619 ++-- sphinx/locale/de_DE/LC_MESSAGES/sphinx.mo | Bin 505 -> 505 bytes sphinx/locale/de_DE/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/el/LC_MESSAGES/sphinx.mo | Bin 80411 -> 77824 bytes sphinx/locale/el/LC_MESSAGES/sphinx.po | 1649 ++-- sphinx/locale/en_DE/LC_MESSAGES/sphinx.mo | Bin 506 -> 506 bytes sphinx/locale/en_DE/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/en_FR/LC_MESSAGES/sphinx.mo | Bin 462 -> 462 bytes sphinx/locale/en_FR/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/en_GB/LC_MESSAGES/sphinx.mo | Bin 75590 -> 73526 bytes sphinx/locale/en_GB/LC_MESSAGES/sphinx.po | 1655 ++-- sphinx/locale/en_HK/LC_MESSAGES/sphinx.mo | Bin 508 -> 508 bytes sphinx/locale/en_HK/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/eo/LC_MESSAGES/sphinx.mo | Bin 1864 -> 1864 bytes sphinx/locale/eo/LC_MESSAGES/sphinx.po | 1583 ++-- sphinx/locale/es/LC_MESSAGES/sphinx.mo | Bin 80907 -> 78628 bytes sphinx/locale/es/LC_MESSAGES/sphinx.po | 1655 ++-- sphinx/locale/es_CO/LC_MESSAGES/sphinx.mo | Bin 546 -> 546 bytes sphinx/locale/es_CO/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/et/LC_MESSAGES/sphinx.mo | Bin 32776 -> 31448 bytes sphinx/locale/et/LC_MESSAGES/sphinx.po | 1633 ++-- sphinx/locale/eu/LC_MESSAGES/sphinx.mo | Bin 6505 -> 6451 bytes sphinx/locale/eu/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/fa/LC_MESSAGES/sphinx.mo | Bin 97001 -> 94375 bytes sphinx/locale/fa/LC_MESSAGES/sphinx.po | 1651 ++-- sphinx/locale/fi/LC_MESSAGES/sphinx.mo | Bin 2912 -> 2860 bytes sphinx/locale/fi/LC_MESSAGES/sphinx.po | 1575 ++-- sphinx/locale/fr/LC_MESSAGES/sphinx.js | 2 +- sphinx/locale/fr/LC_MESSAGES/sphinx.mo | Bin 83168 -> 83602 bytes sphinx/locale/fr/LC_MESSAGES/sphinx.po | 1751 ++-- sphinx/locale/fr_FR/LC_MESSAGES/sphinx.mo | Bin 555 -> 555 bytes sphinx/locale/fr_FR/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/gl/LC_MESSAGES/sphinx.js | 108 +- sphinx/locale/gl/LC_MESSAGES/sphinx.mo | Bin 4716 -> 82300 bytes sphinx/locale/gl/LC_MESSAGES/sphinx.po | 2955 ++++--- sphinx/locale/he/LC_MESSAGES/sphinx.js | 2 +- sphinx/locale/he/LC_MESSAGES/sphinx.mo | Bin 4822 -> 4723 bytes sphinx/locale/he/LC_MESSAGES/sphinx.po | 1589 ++-- sphinx/locale/hi/LC_MESSAGES/sphinx.mo | Bin 96953 -> 93942 bytes sphinx/locale/hi/LC_MESSAGES/sphinx.po | 1649 ++-- sphinx/locale/hi_IN/LC_MESSAGES/sphinx.mo | Bin 502 -> 502 bytes sphinx/locale/hi_IN/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/hr/LC_MESSAGES/sphinx.mo | Bin 16384 -> 15878 bytes sphinx/locale/hr/LC_MESSAGES/sphinx.po | 1631 ++-- sphinx/locale/hu/LC_MESSAGES/sphinx.mo | Bin 10971 -> 10914 bytes sphinx/locale/hu/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/id/LC_MESSAGES/sphinx.mo | Bin 60268 -> 58320 bytes sphinx/locale/id/LC_MESSAGES/sphinx.po | 1651 ++-- sphinx/locale/is/LC_MESSAGES/sphinx.mo | Bin 2614 -> 2614 bytes sphinx/locale/is/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/it/LC_MESSAGES/sphinx.mo | Bin 10036 -> 9978 bytes sphinx/locale/it/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/ja/LC_MESSAGES/sphinx.mo | Bin 85691 -> 83408 bytes sphinx/locale/ja/LC_MESSAGES/sphinx.po | 1649 ++-- sphinx/locale/ka/LC_MESSAGES/sphinx.mo | Bin 74059 -> 72238 bytes sphinx/locale/ka/LC_MESSAGES/sphinx.po | 1639 ++-- sphinx/locale/ko/LC_MESSAGES/sphinx.mo | Bin 82285 -> 79948 bytes sphinx/locale/ko/LC_MESSAGES/sphinx.po | 1653 ++-- sphinx/locale/lt/LC_MESSAGES/sphinx.mo | Bin 6832 -> 6779 bytes sphinx/locale/lt/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/lv/LC_MESSAGES/sphinx.mo | Bin 6501 -> 6449 bytes sphinx/locale/lv/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/mk/LC_MESSAGES/sphinx.mo | Bin 2011 -> 2011 bytes sphinx/locale/mk/LC_MESSAGES/sphinx.po | 1593 ++-- sphinx/locale/nb_NO/LC_MESSAGES/sphinx.js | 54 +- sphinx/locale/nb_NO/LC_MESSAGES/sphinx.mo | Bin 6500 -> 7786 bytes sphinx/locale/nb_NO/LC_MESSAGES/sphinx.po | 1694 ++-- sphinx/locale/ne/LC_MESSAGES/sphinx.mo | Bin 8520 -> 8447 bytes sphinx/locale/ne/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/nl/LC_MESSAGES/sphinx.mo | Bin 18611 -> 18068 bytes sphinx/locale/nl/LC_MESSAGES/sphinx.po | 1631 ++-- sphinx/locale/pl/LC_MESSAGES/sphinx.mo | Bin 28827 -> 28277 bytes sphinx/locale/pl/LC_MESSAGES/sphinx.po | 1633 ++-- sphinx/locale/pt/LC_MESSAGES/sphinx.mo | Bin 544 -> 544 bytes sphinx/locale/pt/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mo | Bin 81014 -> 83715 bytes sphinx/locale/pt_BR/LC_MESSAGES/sphinx.po | 1759 ++-- sphinx/locale/pt_PT/LC_MESSAGES/sphinx.mo | Bin 7764 -> 7711 bytes sphinx/locale/pt_PT/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/ro/LC_MESSAGES/sphinx.mo | Bin 8259 -> 8204 bytes sphinx/locale/ro/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/ru/LC_MESSAGES/sphinx.mo | Bin 15343 -> 15170 bytes sphinx/locale/ru/LC_MESSAGES/sphinx.po | 1619 ++-- sphinx/locale/si/LC_MESSAGES/sphinx.mo | Bin 3560 -> 3488 bytes sphinx/locale/si/LC_MESSAGES/sphinx.po | 1589 ++-- sphinx/locale/sk/LC_MESSAGES/sphinx.mo | Bin 66206 -> 64286 bytes sphinx/locale/sk/LC_MESSAGES/sphinx.po | 1651 ++-- sphinx/locale/sl/LC_MESSAGES/sphinx.mo | Bin 5157 -> 5105 bytes sphinx/locale/sl/LC_MESSAGES/sphinx.po | 1607 ++-- sphinx/locale/sphinx.pot | 1568 ++-- sphinx/locale/sq/LC_MESSAGES/sphinx.js | 2 +- sphinx/locale/sq/LC_MESSAGES/sphinx.mo | Bin 79459 -> 81067 bytes sphinx/locale/sq/LC_MESSAGES/sphinx.po | 1673 ++-- sphinx/locale/sr/LC_MESSAGES/sphinx.mo | Bin 9193 -> 9125 bytes sphinx/locale/sr/LC_MESSAGES/sphinx.po | 1613 ++-- sphinx/locale/sr@latin/LC_MESSAGES/sphinx.mo | Bin 584 -> 584 bytes sphinx/locale/sr_RS/LC_MESSAGES/sphinx.mo | Bin 579 -> 579 bytes sphinx/locale/sv/LC_MESSAGES/sphinx.mo | Bin 6491 -> 6436 bytes sphinx/locale/sv/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/ta/LC_MESSAGES/sphinx.js | 108 +- sphinx/locale/ta/LC_MESSAGES/sphinx.mo | Bin 647 -> 137491 bytes sphinx/locale/ta/LC_MESSAGES/sphinx.po | 3003 +++---- sphinx/locale/te/LC_MESSAGES/sphinx.mo | Bin 489 -> 489 bytes sphinx/locale/te/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/tr/LC_MESSAGES/sphinx.mo | Bin 56773 -> 55037 bytes sphinx/locale/tr/LC_MESSAGES/sphinx.po | 1649 ++-- sphinx/locale/uk_UA/LC_MESSAGES/sphinx.mo | Bin 6349 -> 6287 bytes sphinx/locale/uk_UA/LC_MESSAGES/sphinx.po | 1609 ++-- sphinx/locale/ur/LC_MESSAGES/sphinx.mo | Bin 487 -> 487 bytes sphinx/locale/ur/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/vi/LC_MESSAGES/sphinx.mo | Bin 5771 -> 5710 bytes sphinx/locale/vi/LC_MESSAGES/sphinx.po | 1617 ++-- sphinx/locale/yue/LC_MESSAGES/sphinx.mo | Bin 487 -> 487 bytes sphinx/locale/yue/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/zh_CN/LC_MESSAGES/sphinx.mo | Bin 75427 -> 73260 bytes sphinx/locale/zh_CN/LC_MESSAGES/sphinx.po | 1653 ++-- sphinx/locale/zh_HK/LC_MESSAGES/sphinx.mo | Bin 501 -> 501 bytes sphinx/locale/zh_HK/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.mo | Bin 516 -> 516 bytes sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.po | 1565 ++-- sphinx/locale/zh_TW/LC_MESSAGES/sphinx.js | 2 +- sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mo | Bin 74037 -> 74071 bytes sphinx/locale/zh_TW/LC_MESSAGES/sphinx.po | 1701 ++-- sphinx/parsers.py | 12 +- sphinx/project.py | 29 +- sphinx/pycode/__init__.py | 11 +- sphinx/pycode/ast.py | 31 +- sphinx/pycode/parser.py | 11 +- sphinx/registry.py | 18 +- sphinx/roles.py | 160 +- sphinx/search/__init__.py | 35 +- sphinx/search/da.py | 4 +- sphinx/search/de.py | 4 +- sphinx/search/en.py | 2 +- sphinx/search/es.py | 4 +- sphinx/search/fi.py | 4 +- sphinx/search/fr.py | 4 +- sphinx/search/hu.py | 4 +- sphinx/search/it.py | 4 +- sphinx/search/ja.py | 35 +- sphinx/search/nl.py | 4 +- sphinx/search/no.py | 4 +- sphinx/search/pt.py | 4 +- sphinx/search/ro.py | 2 +- sphinx/search/ru.py | 4 +- sphinx/search/sv.py | 4 +- sphinx/search/tr.py | 2 +- sphinx/search/zh.py | 5 +- sphinx/templates/graphviz/graphviz.css | 2 +- sphinx/testing/fixtures.py | 65 +- sphinx/testing/path.py | 2 +- sphinx/testing/util.py | 195 +- sphinx/texinputs/sphinx.xdy | 2 +- sphinx/texinputs/sphinxlatextables.sty | 2 +- sphinx/texinputs/sphinxpackagesubstitutefont.sty | 21 + sphinx/themes/agogo/layout.html | 8 +- sphinx/themes/agogo/static/agogo.css_t | 2 +- sphinx/themes/agogo/theme.conf | 20 - sphinx/themes/agogo/theme.toml | 22 + sphinx/themes/basic/defindex.html | 2 +- sphinx/themes/basic/domainindex.html | 2 +- sphinx/themes/basic/genindex-single.html | 2 +- sphinx/themes/basic/genindex-split.html | 2 +- sphinx/themes/basic/genindex.html | 2 +- sphinx/themes/basic/globaltoc.html | 2 +- sphinx/themes/basic/layout.html | 2 +- sphinx/themes/basic/localtoc.html | 2 +- sphinx/themes/basic/page.html | 2 +- sphinx/themes/basic/relations.html | 2 +- sphinx/themes/basic/search.html | 25 +- sphinx/themes/basic/searchbox.html | 6 +- sphinx/themes/basic/searchfield.html | 6 +- sphinx/themes/basic/sourcelink.html | 2 +- sphinx/themes/basic/static/basic.css_t | 2 +- sphinx/themes/basic/static/doctools.js | 2 +- sphinx/themes/basic/static/language_data.js_t | 4 +- sphinx/themes/basic/static/searchtools.js | 165 +- sphinx/themes/basic/theme.conf | 16 - sphinx/themes/basic/theme.toml | 23 + sphinx/themes/bizstyle/layout.html | 7 +- sphinx/themes/bizstyle/static/bizstyle.css_t | 2 +- sphinx/themes/bizstyle/static/bizstyle.js_t | 2 +- .../bizstyle/static/css3-mediaqueries_src.js | 6 +- sphinx/themes/bizstyle/theme.conf | 10 - sphinx/themes/bizstyle/theme.toml | 12 + sphinx/themes/classic/layout.html | 2 +- sphinx/themes/classic/static/classic.css_t | 2 +- sphinx/themes/classic/static/sidebar.js_t | 2 +- sphinx/themes/classic/theme.conf | 32 - sphinx/themes/classic/theme.toml | 34 + sphinx/themes/default/theme.conf | 2 - sphinx/themes/default/theme.toml | 2 + sphinx/themes/epub/epub-cover.html | 2 +- sphinx/themes/epub/layout.html | 2 +- sphinx/themes/epub/static/epub.css_t | 2 +- sphinx/themes/epub/theme.conf | 8 - sphinx/themes/epub/theme.toml | 10 + sphinx/themes/haiku/layout.html | 6 +- sphinx/themes/haiku/static/haiku.css_t | 4 +- sphinx/themes/haiku/theme.conf | 14 - sphinx/themes/haiku/theme.toml | 16 + sphinx/themes/nature/static/nature.css_t | 2 +- sphinx/themes/nature/theme.conf | 4 - sphinx/themes/nature/theme.toml | 6 + sphinx/themes/nonav/layout.html | 2 +- sphinx/themes/nonav/static/nonav.css_t | 2 +- sphinx/themes/nonav/theme.conf | 8 - sphinx/themes/nonav/theme.toml | 10 + sphinx/themes/pyramid/static/epub.css_t | 2 +- sphinx/themes/pyramid/static/pyramid.css_t | 2 +- sphinx/themes/pyramid/theme.conf | 4 - sphinx/themes/pyramid/theme.toml | 6 + sphinx/themes/scrolls/artwork/logo.svg | 2 +- sphinx/themes/scrolls/layout.html | 4 +- sphinx/themes/scrolls/static/scrolls.css_t | 2 +- sphinx/themes/scrolls/theme.conf | 13 - sphinx/themes/scrolls/theme.toml | 15 + sphinx/themes/sphinxdoc/static/sphinxdoc.css_t | 2 +- sphinx/themes/sphinxdoc/theme.conf | 4 - sphinx/themes/sphinxdoc/theme.toml | 6 + sphinx/themes/traditional/static/traditional.css_t | 2 +- sphinx/themes/traditional/theme.conf | 7 - sphinx/themes/traditional/theme.toml | 9 + sphinx/theming.py | 600 +- sphinx/transforms/__init__.py | 45 +- sphinx/transforms/compact_bullet_list.py | 10 +- sphinx/transforms/i18n.py | 58 +- sphinx/transforms/post_transforms/__init__.py | 16 +- sphinx/transforms/post_transforms/code.py | 5 +- sphinx/transforms/post_transforms/images.py | 30 +- sphinx/transforms/references.py | 4 +- sphinx/util/__init__.py | 26 +- sphinx/util/_io.py | 34 + sphinx/util/_pathlib.py | 41 +- sphinx/util/build_phase.py | 1 + sphinx/util/cfamily.py | 30 +- sphinx/util/console.py | 122 +- sphinx/util/display.py | 5 +- sphinx/util/docfields.py | 20 +- sphinx/util/docutils.py | 56 +- sphinx/util/exceptions.py | 5 +- sphinx/util/fileutil.py | 10 +- sphinx/util/http_date.py | 11 +- sphinx/util/i18n.py | 49 +- sphinx/util/inspect.py | 562 +- sphinx/util/inventory.py | 27 +- sphinx/util/logging.py | 88 +- sphinx/util/matching.py | 3 +- sphinx/util/math.py | 3 +- sphinx/util/nodes.py | 68 +- sphinx/util/osutil.py | 31 +- sphinx/util/parallel.py | 7 +- sphinx/util/requests.py | 13 +- sphinx/util/rst.py | 14 +- sphinx/util/tags.py | 6 +- sphinx/util/template.py | 11 +- sphinx/util/typing.py | 118 +- sphinx/versioning.py | 8 +- sphinx/writers/html.py | 2 +- sphinx/writers/html5.py | 30 +- sphinx/writers/latex.py | 24 +- sphinx/writers/manpage.py | 20 +- sphinx/writers/texinfo.py | 23 +- sphinx/writers/text.py | 36 +- sphinx/writers/xml.py | 2 +- tests/conftest.py | 30 +- tests/ext_napoleon_pep526_data_google.py | 16 - tests/ext_napoleon_pep526_data_numpy.py | 20 - tests/js/searchtools.js | 99 +- tests/roots/test-changes/base.rst | 3 + tests/roots/test-changes/conf.py | 2 +- tests/roots/test-domain-cpp/operator-lookup.rst | 28 + tests/roots/test-domain-py/module.rst | 6 + tests/roots/test-ext-autodoc/target/enums.py | 231 +- tests/roots/test-ext-autodoc/target/functions.py | 3 + .../target/inherited_annotations.py | 17 + .../target/singledispatchmethod_classmethod.py | 31 + tests/roots/test-ext-doctest-skipif/conf.py | 2 +- tests/roots/test-ext-doctest/doctest.txt | 2 +- .../test-ext-imgmockconverter/mocksvgconverter.py | 4 +- tests/roots/test-ext-intersphinx-role/index.rst | 4 + tests/roots/test-ext-math-include/conf.py | 0 tests/roots/test-ext-math-include/included.rst | 6 + tests/roots/test-ext-math-include/index.rst | 7 + tests/roots/test-ext-math-include/math.rst | 4 + tests/roots/test-ext-napoleon-paramtype/conf.py | 15 + tests/roots/test-ext-napoleon-paramtype/index.rst | 8 + .../test-ext-napoleon-paramtype/pkg/__init__.py | 0 tests/roots/test-ext-napoleon-paramtype/pkg/bar.py | 10 + tests/roots/test-ext-napoleon-paramtype/pkg/foo.py | 27 + tests/roots/test-ext-viewcode/conf.py | 6 +- tests/roots/test-footnotes/index.rst | 8 +- tests/roots/test-images/index.rst | 4 +- tests/roots/test-intl/definition_terms.txt | 2 +- tests/roots/test-intl/external_links.txt | 12 +- tests/roots/test-intl/raw.txt | 2 +- tests/roots/test-intl/refs.txt | 2 +- tests/roots/test-intl/refs_inconsistency.txt | 2 +- tests/roots/test-intl/versionchange.txt | 2 + .../test-intl/xx/LC_MESSAGES/definition_terms.po | 4 +- .../test-intl/xx/LC_MESSAGES/external_links.po | 12 +- tests/roots/test-intl/xx/LC_MESSAGES/raw.po | 4 +- .../test-intl/xx/LC_MESSAGES/versionchange.po | 2 + .../test-linkcheck-anchors-ignore-for-url/conf.py | 2 +- tests/roots/test-linkcheck-anchors-ignore/conf.py | 2 +- .../roots/test-linkcheck-documents_exclude/conf.py | 2 +- .../test-linkcheck-localserver-anchor/conf.py | 2 +- .../roots/test-linkcheck-localserver-https/conf.py | 2 +- .../conf.py | 2 +- tests/roots/test-linkcheck-localserver/conf.py | 2 +- tests/roots/test-linkcheck-raw-node/conf.py | 2 +- tests/roots/test-linkcheck-raw-node/index.rst | 2 - .../roots/test-linkcheck-too-many-retries/conf.py | 2 +- tests/roots/test-linkcheck/conf.py | 2 +- tests/roots/test-manpage_url/index.rst | 10 +- tests/roots/test-need-escaped/index.rst | 2 +- tests/roots/test-roles-download/index.rst | 2 +- tests/roots/test-root/conf.py | 4 +- tests/roots/test-root/images.txt | 3 - tests/roots/test-root/index.txt | 6 +- tests/roots/test-root/markup.txt | 5 +- tests/roots/test-toctree/index.rst | 6 +- tests/roots/test-versioning/insert_beginning.txt | 2 +- tests/test_addnodes.py | 8 +- tests/test_api_translator.py | 92 - tests/test_application.py | 18 +- tests/test_build.py | 135 - tests/test_build_changes.py | 34 - tests/test_build_dirhtml.py | 40 - tests/test_build_epub.py | 411 - tests/test_build_gettext.py | 235 - tests/test_build_html.py | 1841 ---- tests/test_build_latex.py | 1755 ---- tests/test_build_linkcheck.py | 989 --- tests/test_build_manpage.py | 105 - tests/test_build_texinfo.py | 155 - tests/test_build_text.py | 278 - tests/test_builder.py | 39 - tests/test_builders/__init__.py | 0 tests/test_builders/conftest.py | 28 + tests/test_builders/test_build.py | 165 + tests/test_builders/test_build_changes.py | 34 + tests/test_builders/test_build_dirhtml.py | 40 + tests/test_builders/test_build_epub.py | 417 + tests/test_builders/test_build_gettext.py | 235 + tests/test_builders/test_build_html.py | 378 + tests/test_builders/test_build_html_5_output.py | 276 + tests/test_builders/test_build_html_assets.py | 152 + tests/test_builders/test_build_html_code.py | 46 + tests/test_builders/test_build_html_download.py | 62 + tests/test_builders/test_build_html_highlight.py | 61 + tests/test_builders/test_build_html_image.py | 80 + tests/test_builders/test_build_html_maths.py | 58 + tests/test_builders/test_build_html_numfig.py | 487 + tests/test_builders/test_build_html_tocdepth.py | 94 + tests/test_builders/test_build_latex.py | 1759 ++++ tests/test_builders/test_build_linkcheck.py | 1040 +++ tests/test_builders/test_build_manpage.py | 104 + tests/test_builders/test_build_texinfo.py | 130 + tests/test_builders/test_build_text.py | 278 + tests/test_builders/test_build_warnings.py | 89 + tests/test_builders/test_builder.py | 44 + tests/test_builders/xpath_data.py | 8 + tests/test_builders/xpath_util.py | 79 + tests/test_catalogs.py | 74 - tests/test_config.py | 517 -- tests/test_config/__init__.py | 0 tests/test_config/test_config.py | 805 ++ tests/test_config/test_correct_year.py | 29 + tests/test_correct_year.py | 29 - tests/test_directive_code.py | 595 -- tests/test_directive_object_description.py | 59 - tests/test_directive_only.py | 46 - tests/test_directive_other.py | 195 - tests/test_directive_patch.py | 110 - tests/test_directives/__init__.py | 0 tests/test_directives/test_directive_code.py | 595 ++ .../test_directive_object_description.py | 59 + tests/test_directives/test_directive_only.py | 46 + tests/test_directives/test_directive_option.py | 40 + tests/test_directives/test_directive_other.py | 195 + tests/test_directives/test_directive_patch.py | 110 + .../test_directives_no_typesetting.py | 108 + tests/test_directives_no_typesetting.py | 108 - tests/test_docutilsconf.py | 29 - tests/test_domain_c.py | 1076 --- tests/test_domain_cpp.py | 1744 ---- tests/test_domain_js.py | 505 -- tests/test_domain_py.py | 2123 ----- tests/test_domain_rst.py | 137 - tests/test_domain_std.py | 495 -- tests/test_domains/__init__.py | 0 tests/test_domains/test_domain_c.py | 1072 +++ tests/test_domains/test_domain_cpp.py | 1753 ++++ tests/test_domains/test_domain_js.py | 505 ++ tests/test_domains/test_domain_py.py | 1015 +++ tests/test_domains/test_domain_py_canonical.py | 77 + tests/test_domains/test_domain_py_fields.py | 326 + tests/test_domains/test_domain_py_pyfunction.py | 396 + tests/test_domains/test_domain_py_pyobject.py | 487 + tests/test_domains/test_domain_rst.py | 137 + tests/test_domains/test_domain_std.py | 517 ++ tests/test_environment.py | 145 - tests/test_environment/__init__.py | 0 tests/test_environment/test_environment.py | 145 + .../test_environment_indexentries.py | 166 + .../test_environment_record_dependencies.py | 10 + tests/test_environment/test_environment_toctree.py | 396 + tests/test_environment_indexentries.py | 166 - tests/test_environment_record_dependencies.py | 10 - tests/test_environment_toctree.py | 396 - tests/test_events.py | 10 +- tests/test_ext_apidoc.py | 665 -- tests/test_ext_autodoc.py | 2537 ------ tests/test_ext_autodoc_autoattribute.py | 176 - tests/test_ext_autodoc_autoclass.py | 517 -- tests/test_ext_autodoc_autodata.py | 106 - tests/test_ext_autodoc_autofunction.py | 201 - tests/test_ext_autodoc_automodule.py | 192 - tests/test_ext_autodoc_autoproperty.py | 91 - tests/test_ext_autodoc_configs.py | 1727 ---- tests/test_ext_autodoc_events.py | 118 - tests/test_ext_autodoc_mock.py | 152 - tests/test_ext_autodoc_preserve_defaults.py | 192 - tests/test_ext_autodoc_private_members.py | 158 - tests/test_ext_autosectionlabel.py | 77 - tests/test_ext_autosummary.py | 686 -- tests/test_ext_coverage.py | 101 - tests/test_ext_doctest.py | 136 - tests/test_ext_duration.py | 14 - tests/test_ext_extlinks.py | 45 - tests/test_ext_githubpages.py | 26 - tests/test_ext_graphviz.py | 196 - tests/test_ext_ifconfig.py | 28 - tests/test_ext_imgconverter.py | 34 - tests/test_ext_imgmockconverter.py | 17 - tests/test_ext_inheritance_diagram.py | 342 - tests/test_ext_intersphinx.py | 568 -- tests/test_ext_math.py | 345 - tests/test_ext_napoleon.py | 218 - tests/test_ext_napoleon_docstring.py | 2660 ------ tests/test_ext_todo.py | 109 - tests/test_ext_viewcode.py | 137 - tests/test_extension.py | 23 - tests/test_extensions/__init__.py | 0 tests/test_extensions/autodoc_util.py | 33 + .../ext_napoleon_pep526_data_google.py | 16 + .../ext_napoleon_pep526_data_numpy.py | 21 + tests/test_extensions/test_ext_apidoc.py | 663 ++ tests/test_extensions/test_ext_autodoc.py | 2923 ++++++ .../test_ext_autodoc_autoattribute.py | 176 + .../test_extensions/test_ext_autodoc_autoclass.py | 566 ++ tests/test_extensions/test_ext_autodoc_autodata.py | 106 + .../test_ext_autodoc_autofunction.py | 212 + .../test_extensions/test_ext_autodoc_automodule.py | 192 + .../test_ext_autodoc_autoproperty.py | 91 + tests/test_extensions/test_ext_autodoc_configs.py | 1743 ++++ tests/test_extensions/test_ext_autodoc_events.py | 118 + tests/test_extensions/test_ext_autodoc_mock.py | 152 + .../test_ext_autodoc_preserve_defaults.py | 192 + .../test_ext_autodoc_private_members.py | 158 + tests/test_extensions/test_ext_autosectionlabel.py | 77 + tests/test_extensions/test_ext_autosummary.py | 686 ++ tests/test_extensions/test_ext_coverage.py | 101 + tests/test_extensions/test_ext_doctest.py | 135 + tests/test_extensions/test_ext_duration.py | 14 + tests/test_extensions/test_ext_extlinks.py | 45 + tests/test_extensions/test_ext_githubpages.py | 26 + tests/test_extensions/test_ext_graphviz.py | 196 + tests/test_extensions/test_ext_ifconfig.py | 28 + tests/test_extensions/test_ext_imgconverter.py | 35 + tests/test_extensions/test_ext_imgmockconverter.py | 17 + .../test_ext_inheritance_diagram.py | 342 + tests/test_extensions/test_ext_intersphinx.py | 584 ++ tests/test_extensions/test_ext_math.py | 389 + tests/test_extensions/test_ext_napoleon.py | 218 + .../test_extensions/test_ext_napoleon_docstring.py | 2703 ++++++ tests/test_extensions/test_ext_todo.py | 108 + tests/test_extensions/test_ext_viewcode.py | 137 + tests/test_extensions/test_extension.py | 23 + tests/test_intl.py | 1527 ---- tests/test_intl/__init__.py | 0 tests/test_intl/test_catalogs.py | 74 + tests/test_intl/test_intl.py | 1672 ++++ tests/test_intl/test_locale.py | 76 + tests/test_locale.py | 76 - tests/test_markup.py | 619 -- tests/test_markup/__init__.py | 0 tests/test_markup/test_markup.py | 619 ++ tests/test_markup/test_metadata.py | 43 + tests/test_markup/test_parser.py | 57 + tests/test_markup/test_smartquotes.py | 98 + tests/test_metadata.py | 43 - tests/test_parser.py | 57 - tests/test_pycode.py | 173 - tests/test_pycode/__init__.py | 0 tests/test_pycode/test_pycode.py | 173 + tests/test_pycode/test_pycode_ast.py | 68 + tests/test_pycode/test_pycode_parser.py | 511 ++ tests/test_pycode_ast.py | 62 - tests/test_pycode_parser.py | 511 -- tests/test_quickstart.py | 2 +- tests/test_search.py | 60 +- tests/test_smartquotes.py | 99 - tests/test_templating.py | 41 - tests/test_theming.py | 131 - tests/test_theming/__init__.py | 0 tests/test_theming/test_html_theme.py | 35 + tests/test_theming/test_templating.py | 48 + tests/test_theming/test_theming.py | 227 + tests/test_theming/theme.conf | 7 + tests/test_theming/theme.toml | 10 + tests/test_toctree.py | 6 +- tests/test_transforms/__init__.py | 0 .../test_transforms_move_module_targets.py | 77 + .../test_transforms_post_transforms.py | 269 + .../test_transforms_post_transforms_code.py | 44 + .../test_transforms_reorder_nodes.py | 96 + tests/test_transforms_move_module_targets.py | 77 - tests/test_transforms_post_transforms.py | 268 - tests/test_transforms_post_transforms_code.py | 44 - tests/test_transforms_reorder_nodes.py | 96 - tests/test_util.py | 73 - tests/test_util/__init__.py | 0 tests/test_util/intersphinx_data.py | 52 + tests/test_util/test_util.py | 73 + tests/test_util/test_util_console.py | 90 + tests/test_util/test_util_display.py | 105 + tests/test_util/test_util_docstrings.py | 88 + tests/test_util/test_util_docutils.py | 92 + tests/test_util/test_util_fileutil.py | 103 + tests/test_util/test_util_i18n.py | 192 + tests/test_util/test_util_images.py | 74 + tests/test_util/test_util_inspect.py | 853 ++ tests/test_util/test_util_inventory.py | 78 + tests/test_util/test_util_logging.py | 414 + tests/test_util/test_util_matching.py | 174 + tests/test_util/test_util_nodes.py | 254 + tests/test_util/test_util_rst.py | 164 + tests/test_util/test_util_template.py | 29 + tests/test_util/test_util_typing.py | 633 ++ tests/test_util/typing_test_data.py | 129 + tests/test_util_display.py | 103 - tests/test_util_docstrings.py | 88 - tests/test_util_docutils.py | 92 - tests/test_util_fileutil.py | 103 - tests/test_util_i18n.py | 190 - tests/test_util_images.py | 74 - tests/test_util_inspect.py | 869 -- tests/test_util_inventory.py | 116 - tests/test_util_logging.py | 398 - tests/test_util_matching.py | 174 - tests/test_util_nodes.py | 254 - tests/test_util_rst.py | 164 - tests/test_util_template.py | 29 - tests/test_util_typing.py | 536 -- tests/test_writer_latex.py | 28 - tests/test_writers/__init__.py | 0 tests/test_writers/test_api_translator.py | 92 + tests/test_writers/test_docutilsconf.py | 29 + tests/test_writers/test_writer_latex.py | 28 + tests/typing_test_data.py | 129 - tests/utils.py | 130 +- utils/CHANGES_template | 20 - utils/CHANGES_template.rst | 20 + utils/babel_runner.py | 96 +- utils/bump_docker.py | 32 +- utils/bump_version.py | 57 +- utils/release-checklist | 70 - utils/release-checklist.rst | 70 + 777 files changed, 127607 insertions(+), 118224 deletions(-) delete mode 100644 AUTHORS create mode 100644 AUTHORS.rst delete mode 100644 CHANGES create mode 100644 CHANGES.rst delete mode 100644 CODE_OF_CONDUCT create mode 100644 CODE_OF_CONDUCT.rst delete mode 100644 EXAMPLES create mode 100644 EXAMPLES.rst delete mode 100644 LICENSE create mode 100644 LICENSE.rst create mode 100644 doc/_themes/sphinx13/static/sphinx-logo.svg delete mode 100644 doc/_themes/sphinx13/static/sphinxheader.png delete mode 100644 doc/_themes/sphinx13/theme.conf create mode 100644 doc/_themes/sphinx13/theme.toml create mode 100644 doc/usage/domains/c.rst create mode 100644 doc/usage/domains/cpp.rst create mode 100644 doc/usage/domains/index.rst create mode 100644 doc/usage/domains/javascript.rst create mode 100644 doc/usage/domains/mathematics.rst create mode 100644 doc/usage/domains/python.rst create mode 100644 doc/usage/domains/restructuredtext.rst create mode 100644 doc/usage/domains/standard.rst create mode 100644 doc/usage/referencing.rst delete mode 100644 sphinx/domains/c.py create mode 100644 sphinx/domains/c/__init__.py create mode 100644 sphinx/domains/c/_ast.py create mode 100644 sphinx/domains/c/_ids.py create mode 100644 sphinx/domains/c/_parser.py create mode 100644 sphinx/domains/c/_symbol.py delete mode 100644 sphinx/domains/cpp.py create mode 100644 sphinx/domains/cpp/__init__.py create mode 100644 sphinx/domains/cpp/_ast.py create mode 100644 sphinx/domains/cpp/_ids.py create mode 100644 sphinx/domains/cpp/_parser.py create mode 100644 sphinx/domains/cpp/_symbol.py delete mode 100644 sphinx/domains/python.py create mode 100644 sphinx/domains/python/__init__.py create mode 100644 sphinx/domains/python/_annotations.py create mode 100644 sphinx/domains/python/_object.py delete mode 100644 sphinx/domains/std.py create mode 100644 sphinx/domains/std/__init__.py create mode 100644 sphinx/texinputs/sphinxpackagesubstitutefont.sty delete mode 100644 sphinx/themes/agogo/theme.conf create mode 100644 sphinx/themes/agogo/theme.toml delete mode 100644 sphinx/themes/basic/theme.conf create mode 100644 sphinx/themes/basic/theme.toml delete mode 100644 sphinx/themes/bizstyle/theme.conf create mode 100644 sphinx/themes/bizstyle/theme.toml delete mode 100644 sphinx/themes/classic/theme.conf create mode 100644 sphinx/themes/classic/theme.toml delete mode 100644 sphinx/themes/default/theme.conf create mode 100644 sphinx/themes/default/theme.toml delete mode 100644 sphinx/themes/epub/theme.conf create mode 100644 sphinx/themes/epub/theme.toml delete mode 100644 sphinx/themes/haiku/theme.conf create mode 100644 sphinx/themes/haiku/theme.toml delete mode 100644 sphinx/themes/nature/theme.conf create mode 100644 sphinx/themes/nature/theme.toml delete mode 100644 sphinx/themes/nonav/theme.conf create mode 100644 sphinx/themes/nonav/theme.toml delete mode 100644 sphinx/themes/pyramid/theme.conf create mode 100644 sphinx/themes/pyramid/theme.toml delete mode 100644 sphinx/themes/scrolls/theme.conf create mode 100644 sphinx/themes/scrolls/theme.toml delete mode 100644 sphinx/themes/sphinxdoc/theme.conf create mode 100644 sphinx/themes/sphinxdoc/theme.toml delete mode 100644 sphinx/themes/traditional/theme.conf create mode 100644 sphinx/themes/traditional/theme.toml create mode 100644 sphinx/util/_io.py delete mode 100644 tests/ext_napoleon_pep526_data_google.py delete mode 100644 tests/ext_napoleon_pep526_data_numpy.py create mode 100644 tests/roots/test-domain-cpp/operator-lookup.rst create mode 100644 tests/roots/test-ext-autodoc/target/inherited_annotations.py create mode 100644 tests/roots/test-ext-autodoc/target/singledispatchmethod_classmethod.py create mode 100644 tests/roots/test-ext-math-include/conf.py create mode 100644 tests/roots/test-ext-math-include/included.rst create mode 100644 tests/roots/test-ext-math-include/index.rst create mode 100644 tests/roots/test-ext-math-include/math.rst create mode 100644 tests/roots/test-ext-napoleon-paramtype/conf.py create mode 100644 tests/roots/test-ext-napoleon-paramtype/index.rst create mode 100644 tests/roots/test-ext-napoleon-paramtype/pkg/__init__.py create mode 100644 tests/roots/test-ext-napoleon-paramtype/pkg/bar.py create mode 100644 tests/roots/test-ext-napoleon-paramtype/pkg/foo.py delete mode 100644 tests/roots/test-linkcheck-raw-node/index.rst delete mode 100644 tests/test_api_translator.py delete mode 100644 tests/test_build.py delete mode 100644 tests/test_build_changes.py delete mode 100644 tests/test_build_dirhtml.py delete mode 100644 tests/test_build_epub.py delete mode 100644 tests/test_build_gettext.py delete mode 100644 tests/test_build_html.py delete mode 100644 tests/test_build_latex.py delete mode 100644 tests/test_build_linkcheck.py delete mode 100644 tests/test_build_manpage.py delete mode 100644 tests/test_build_texinfo.py delete mode 100644 tests/test_build_text.py delete mode 100644 tests/test_builder.py create mode 100644 tests/test_builders/__init__.py create mode 100644 tests/test_builders/conftest.py create mode 100644 tests/test_builders/test_build.py create mode 100644 tests/test_builders/test_build_changes.py create mode 100644 tests/test_builders/test_build_dirhtml.py create mode 100644 tests/test_builders/test_build_epub.py create mode 100644 tests/test_builders/test_build_gettext.py create mode 100644 tests/test_builders/test_build_html.py create mode 100644 tests/test_builders/test_build_html_5_output.py create mode 100644 tests/test_builders/test_build_html_assets.py create mode 100644 tests/test_builders/test_build_html_code.py create mode 100644 tests/test_builders/test_build_html_download.py create mode 100644 tests/test_builders/test_build_html_highlight.py create mode 100644 tests/test_builders/test_build_html_image.py create mode 100644 tests/test_builders/test_build_html_maths.py create mode 100644 tests/test_builders/test_build_html_numfig.py create mode 100644 tests/test_builders/test_build_html_tocdepth.py create mode 100644 tests/test_builders/test_build_latex.py create mode 100644 tests/test_builders/test_build_linkcheck.py create mode 100644 tests/test_builders/test_build_manpage.py create mode 100644 tests/test_builders/test_build_texinfo.py create mode 100644 tests/test_builders/test_build_text.py create mode 100644 tests/test_builders/test_build_warnings.py create mode 100644 tests/test_builders/test_builder.py create mode 100644 tests/test_builders/xpath_data.py create mode 100644 tests/test_builders/xpath_util.py delete mode 100644 tests/test_catalogs.py delete mode 100644 tests/test_config.py create mode 100644 tests/test_config/__init__.py create mode 100644 tests/test_config/test_config.py create mode 100644 tests/test_config/test_correct_year.py delete mode 100644 tests/test_correct_year.py delete mode 100644 tests/test_directive_code.py delete mode 100644 tests/test_directive_object_description.py delete mode 100644 tests/test_directive_only.py delete mode 100644 tests/test_directive_other.py delete mode 100644 tests/test_directive_patch.py create mode 100644 tests/test_directives/__init__.py create mode 100644 tests/test_directives/test_directive_code.py create mode 100644 tests/test_directives/test_directive_object_description.py create mode 100644 tests/test_directives/test_directive_only.py create mode 100644 tests/test_directives/test_directive_option.py create mode 100644 tests/test_directives/test_directive_other.py create mode 100644 tests/test_directives/test_directive_patch.py create mode 100644 tests/test_directives/test_directives_no_typesetting.py delete mode 100644 tests/test_directives_no_typesetting.py delete mode 100644 tests/test_docutilsconf.py delete mode 100644 tests/test_domain_c.py delete mode 100644 tests/test_domain_cpp.py delete mode 100644 tests/test_domain_js.py delete mode 100644 tests/test_domain_py.py delete mode 100644 tests/test_domain_rst.py delete mode 100644 tests/test_domain_std.py create mode 100644 tests/test_domains/__init__.py create mode 100644 tests/test_domains/test_domain_c.py create mode 100644 tests/test_domains/test_domain_cpp.py create mode 100644 tests/test_domains/test_domain_js.py create mode 100644 tests/test_domains/test_domain_py.py create mode 100644 tests/test_domains/test_domain_py_canonical.py create mode 100644 tests/test_domains/test_domain_py_fields.py create mode 100644 tests/test_domains/test_domain_py_pyfunction.py create mode 100644 tests/test_domains/test_domain_py_pyobject.py create mode 100644 tests/test_domains/test_domain_rst.py create mode 100644 tests/test_domains/test_domain_std.py delete mode 100644 tests/test_environment.py create mode 100644 tests/test_environment/__init__.py create mode 100644 tests/test_environment/test_environment.py create mode 100644 tests/test_environment/test_environment_indexentries.py create mode 100644 tests/test_environment/test_environment_record_dependencies.py create mode 100644 tests/test_environment/test_environment_toctree.py delete mode 100644 tests/test_environment_indexentries.py delete mode 100644 tests/test_environment_record_dependencies.py delete mode 100644 tests/test_environment_toctree.py delete mode 100644 tests/test_ext_apidoc.py delete mode 100644 tests/test_ext_autodoc.py delete mode 100644 tests/test_ext_autodoc_autoattribute.py delete mode 100644 tests/test_ext_autodoc_autoclass.py delete mode 100644 tests/test_ext_autodoc_autodata.py delete mode 100644 tests/test_ext_autodoc_autofunction.py delete mode 100644 tests/test_ext_autodoc_automodule.py delete mode 100644 tests/test_ext_autodoc_autoproperty.py delete mode 100644 tests/test_ext_autodoc_configs.py delete mode 100644 tests/test_ext_autodoc_events.py delete mode 100644 tests/test_ext_autodoc_mock.py delete mode 100644 tests/test_ext_autodoc_preserve_defaults.py delete mode 100644 tests/test_ext_autodoc_private_members.py delete mode 100644 tests/test_ext_autosectionlabel.py delete mode 100644 tests/test_ext_autosummary.py delete mode 100644 tests/test_ext_coverage.py delete mode 100644 tests/test_ext_doctest.py delete mode 100644 tests/test_ext_duration.py delete mode 100644 tests/test_ext_extlinks.py delete mode 100644 tests/test_ext_githubpages.py delete mode 100644 tests/test_ext_graphviz.py delete mode 100644 tests/test_ext_ifconfig.py delete mode 100644 tests/test_ext_imgconverter.py delete mode 100644 tests/test_ext_imgmockconverter.py delete mode 100644 tests/test_ext_inheritance_diagram.py delete mode 100644 tests/test_ext_intersphinx.py delete mode 100644 tests/test_ext_math.py delete mode 100644 tests/test_ext_napoleon.py delete mode 100644 tests/test_ext_napoleon_docstring.py delete mode 100644 tests/test_ext_todo.py delete mode 100644 tests/test_ext_viewcode.py delete mode 100644 tests/test_extension.py create mode 100644 tests/test_extensions/__init__.py create mode 100644 tests/test_extensions/autodoc_util.py create mode 100644 tests/test_extensions/ext_napoleon_pep526_data_google.py create mode 100644 tests/test_extensions/ext_napoleon_pep526_data_numpy.py create mode 100644 tests/test_extensions/test_ext_apidoc.py create mode 100644 tests/test_extensions/test_ext_autodoc.py create mode 100644 tests/test_extensions/test_ext_autodoc_autoattribute.py create mode 100644 tests/test_extensions/test_ext_autodoc_autoclass.py create mode 100644 tests/test_extensions/test_ext_autodoc_autodata.py create mode 100644 tests/test_extensions/test_ext_autodoc_autofunction.py create mode 100644 tests/test_extensions/test_ext_autodoc_automodule.py create mode 100644 tests/test_extensions/test_ext_autodoc_autoproperty.py create mode 100644 tests/test_extensions/test_ext_autodoc_configs.py create mode 100644 tests/test_extensions/test_ext_autodoc_events.py create mode 100644 tests/test_extensions/test_ext_autodoc_mock.py create mode 100644 tests/test_extensions/test_ext_autodoc_preserve_defaults.py create mode 100644 tests/test_extensions/test_ext_autodoc_private_members.py create mode 100644 tests/test_extensions/test_ext_autosectionlabel.py create mode 100644 tests/test_extensions/test_ext_autosummary.py create mode 100644 tests/test_extensions/test_ext_coverage.py create mode 100644 tests/test_extensions/test_ext_doctest.py create mode 100644 tests/test_extensions/test_ext_duration.py create mode 100644 tests/test_extensions/test_ext_extlinks.py create mode 100644 tests/test_extensions/test_ext_githubpages.py create mode 100644 tests/test_extensions/test_ext_graphviz.py create mode 100644 tests/test_extensions/test_ext_ifconfig.py create mode 100644 tests/test_extensions/test_ext_imgconverter.py create mode 100644 tests/test_extensions/test_ext_imgmockconverter.py create mode 100644 tests/test_extensions/test_ext_inheritance_diagram.py create mode 100644 tests/test_extensions/test_ext_intersphinx.py create mode 100644 tests/test_extensions/test_ext_math.py create mode 100644 tests/test_extensions/test_ext_napoleon.py create mode 100644 tests/test_extensions/test_ext_napoleon_docstring.py create mode 100644 tests/test_extensions/test_ext_todo.py create mode 100644 tests/test_extensions/test_ext_viewcode.py create mode 100644 tests/test_extensions/test_extension.py delete mode 100644 tests/test_intl.py create mode 100644 tests/test_intl/__init__.py create mode 100644 tests/test_intl/test_catalogs.py create mode 100644 tests/test_intl/test_intl.py create mode 100644 tests/test_intl/test_locale.py delete mode 100644 tests/test_locale.py delete mode 100644 tests/test_markup.py create mode 100644 tests/test_markup/__init__.py create mode 100644 tests/test_markup/test_markup.py create mode 100644 tests/test_markup/test_metadata.py create mode 100644 tests/test_markup/test_parser.py create mode 100644 tests/test_markup/test_smartquotes.py delete mode 100644 tests/test_metadata.py delete mode 100644 tests/test_parser.py delete mode 100644 tests/test_pycode.py create mode 100644 tests/test_pycode/__init__.py create mode 100644 tests/test_pycode/test_pycode.py create mode 100644 tests/test_pycode/test_pycode_ast.py create mode 100644 tests/test_pycode/test_pycode_parser.py delete mode 100644 tests/test_pycode_ast.py delete mode 100644 tests/test_pycode_parser.py delete mode 100644 tests/test_smartquotes.py delete mode 100644 tests/test_templating.py delete mode 100644 tests/test_theming.py create mode 100644 tests/test_theming/__init__.py create mode 100644 tests/test_theming/test_html_theme.py create mode 100644 tests/test_theming/test_templating.py create mode 100644 tests/test_theming/test_theming.py create mode 100644 tests/test_theming/theme.conf create mode 100644 tests/test_theming/theme.toml create mode 100644 tests/test_transforms/__init__.py create mode 100644 tests/test_transforms/test_transforms_move_module_targets.py create mode 100644 tests/test_transforms/test_transforms_post_transforms.py create mode 100644 tests/test_transforms/test_transforms_post_transforms_code.py create mode 100644 tests/test_transforms/test_transforms_reorder_nodes.py delete mode 100644 tests/test_transforms_move_module_targets.py delete mode 100644 tests/test_transforms_post_transforms.py delete mode 100644 tests/test_transforms_post_transforms_code.py delete mode 100644 tests/test_transforms_reorder_nodes.py delete mode 100644 tests/test_util.py create mode 100644 tests/test_util/__init__.py create mode 100644 tests/test_util/intersphinx_data.py create mode 100644 tests/test_util/test_util.py create mode 100644 tests/test_util/test_util_console.py create mode 100644 tests/test_util/test_util_display.py create mode 100644 tests/test_util/test_util_docstrings.py create mode 100644 tests/test_util/test_util_docutils.py create mode 100644 tests/test_util/test_util_fileutil.py create mode 100644 tests/test_util/test_util_i18n.py create mode 100644 tests/test_util/test_util_images.py create mode 100644 tests/test_util/test_util_inspect.py create mode 100644 tests/test_util/test_util_inventory.py create mode 100644 tests/test_util/test_util_logging.py create mode 100644 tests/test_util/test_util_matching.py create mode 100644 tests/test_util/test_util_nodes.py create mode 100644 tests/test_util/test_util_rst.py create mode 100644 tests/test_util/test_util_template.py create mode 100644 tests/test_util/test_util_typing.py create mode 100644 tests/test_util/typing_test_data.py delete mode 100644 tests/test_util_display.py delete mode 100644 tests/test_util_docstrings.py delete mode 100644 tests/test_util_docutils.py delete mode 100644 tests/test_util_fileutil.py delete mode 100644 tests/test_util_i18n.py delete mode 100644 tests/test_util_images.py delete mode 100644 tests/test_util_inspect.py delete mode 100644 tests/test_util_inventory.py delete mode 100644 tests/test_util_logging.py delete mode 100644 tests/test_util_matching.py delete mode 100644 tests/test_util_nodes.py delete mode 100644 tests/test_util_rst.py delete mode 100644 tests/test_util_template.py delete mode 100644 tests/test_util_typing.py delete mode 100644 tests/test_writer_latex.py create mode 100644 tests/test_writers/__init__.py create mode 100644 tests/test_writers/test_api_translator.py create mode 100644 tests/test_writers/test_docutilsconf.py create mode 100644 tests/test_writers/test_writer_latex.py delete mode 100644 tests/typing_test_data.py delete mode 100644 utils/CHANGES_template create mode 100644 utils/CHANGES_template.rst mode change 100644 => 100755 utils/bump_docker.py delete mode 100644 utils/release-checklist create mode 100644 utils/release-checklist.rst diff --git a/AUTHORS b/AUTHORS deleted file mode 100644 index 786d28c..0000000 --- a/AUTHORS +++ /dev/null @@ -1,95 +0,0 @@ -Maintainers -=========== - -*Listed alphabetically in forename, surname order* - -* Adam Turner <@AA-Turner> -* Armin Ronacher -* Daniel Neuhäuser <@DasIch> -* François Freitag <@francoisfreitag> -* Georg Brandl -* Jakob Lykke Andersen <@jakobandersen> -* Jean-François Burnol <@jfbu> -* Rob Ruana <@RobRuana> -* Robert Lehmann <@lehmannro> -* Stephen Finucane <@stephenfin> -* Takayuki Shimizukawa -* Takeshi Komiya <@tk0miya> -* Timotheus Kampik <@TimKam> -* Yoshiki Shibukawa <@shibukawa> - -Contributors -============ - -*Listed alphabetically in forename, surname order* - -* Adrián Chaves (Gallaecio) -- coverage builder improvements -* Alastair Houghton -- Apple Help builder -* 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 -* Ben Egan -- Napoleon improvements -* Benjamin Peterson -- unittests -* Blaise Laflamme -- pyramid theme -* Bruce Mitchener -- Minor epub improvement -* Buck Evan -- dummy builder -* Charles Duffy -- original graphviz extension -* Chris Lamb -- reproducibility fixes -* Christopher Perkins -- autosummary integration -* Dan MacKinlay -- metadata fixes -* Daniel Bültmann -- todo extension -* Daniel Neuhäuser -- JavaScript domain, Python 3 support (GSOC) -* Daniel Pizetta -- inheritance diagram improvements -* Dave Kuhlman -- original LaTeX writer -* Doug Hellmann -- graphviz improvements -* Eric N. Vander Weele -- 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) -* Jeppe Pihl -- literalinclude improvements -* Joel Wurtz -- cellspanning support in LaTeX -* John Waltman -- Texinfo builder -* Josip Dzolonga -- coverage builder -* Julien Palard -- Colspan and rowspan in text builder -* 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 -* Łukasz Langa -- partial support for autodoc -* Marco Buttu -- doctest extension (pyversion option) -* Martin Hans -- autodoc improvements -* Martin Larralde -- additional napoleon admonitions -* Martin Mahner -- nature theme -* Matthew Fernandez -- todo extension fix -* Matthew Woodcraft -- text output improvements -* Michael Droettboom -- inheritance_diagram extension -* Michael Wilson -- Intersphinx HTTP basic auth support -* Nathan Damon -- bugfix in validation of static paths in html builders -* Pauli Virtanen -- autodoc improvements, autosummary extension -* Rob Ruana -- napoleon extension -* Robert Lehmann -- gettext builder (GSOC project) -* Roland Meister -- epub builder -* Sebastian Wiesner -- image handling, distutils support -* 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 - -Many thanks for all contributions! diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..1b4d6e7 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,106 @@ +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 Burnol <@jfbu> +* Stephen Finucane <@stephenfin> +* Takayuki Shimizukawa <@shimizukawa> +* Takeshi Komiya <@tk0miya> + +Contributors +============ + +*Listed alphabetically in forename, surname order* + +* Adrián Chaves (Gallaecio) -- coverage builder improvements +* Alastair Houghton -- Apple Help builder +* 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 +* Ben Egan -- Napoleon improvements +* Benjamin Peterson -- unittests +* Blaise Laflamme -- pyramid theme +* Bruce Mitchener -- Minor epub improvement +* Buck Evan -- dummy builder +* Charles Duffy -- original graphviz extension +* Chris Lamb -- reproducibility fixes +* Christopher Perkins -- autosummary integration +* Dan MacKinlay -- metadata fixes +* Daniel Bültmann -- todo extension +* Daniel Neuhäuser -- JavaScript domain, Python 3 support (GSOC) +* Daniel Pizetta -- inheritance diagram improvements +* Dave Kuhlman -- original LaTeX writer +* Doug Hellmann -- graphviz improvements +* Eric N. Vander Weele -- 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) +* Jeppe Pihl -- literalinclude improvements +* Joel Wurtz -- cellspanning support in LaTeX +* John Waltman -- Texinfo builder +* Josip Dzolonga -- coverage builder +* Julien Palard -- Colspan and rowspan in text builder +* 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 +* Łukasz Langa -- partial support for autodoc +* Marco Buttu -- doctest extension (pyversion option) +* Martin Hans -- autodoc improvements +* Martin Larralde -- additional napoleon admonitions +* Martin Mahner -- nature theme +* Matthew Fernandez -- todo extension fix +* Matthew Woodcraft -- text output improvements +* Michael Droettboom -- inheritance_diagram extension +* Michael Wilson -- Intersphinx HTTP basic auth support +* Nathan Damon -- bugfix in validation of static paths in html builders +* Pauli Virtanen -- autodoc improvements, autosummary extension +* Rob Ruana -- napoleon extension +* Robert Lehmann -- gettext builder (GSOC project) +* Roland Meister -- epub builder +* Sebastian Wiesner -- image handling, distutils support +* 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 +* Rob Ruana <@RobRuana> +* Robert Lehmann <@lehmannro> +* Timotheus Kampik <@TimKam> +* Yoshiki Shibukawa <@shibukawa> + +Many thanks for all contributions! diff --git a/CHANGES b/CHANGES deleted file mode 100644 index 84c7abf..0000000 --- a/CHANGES +++ /dev/null @@ -1,9019 +0,0 @@ -Release 7.2.6 (released Sep 13, 2023) -===================================== - -Bugs fixed ----------- - -* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES` environment variable, - which if set reloads modules when using autodoc with ``TYPE_CHECKING = True``. - Patch by Matt Wozniski and Adam Turner. -* #11679: Use :py:func:`importlib.reload` to reload modules in autodoc. - Patch by Matt Wozniski and Adam Turner. - -Release 7.2.5 (released Aug 30, 2023) -===================================== - -Bugs fixed ----------- - -* #11645: Fix a regression preventing autodoc from importing modules within - packages that make use of ``if typing.TYPE_CHECKING:`` to guard circular - imports needed by type checkers. - Patch by Matt Wozniski. -* #11634: Fixed inheritance diagram relative link resolution - for sibling files in a subdirectory. - Patch by Albert Shih. -* #11659: Allow ``?config=...`` in :confval:`mathjax_path`. -* #11654: autodoc: Fail with a more descriptive error message - when an object claims to be an instance of ``type``, - but is not a class. - Patch by James Braza. -* 11620: Cease emitting :event:`source-read` events for files read via - the :dudir:`include` directive. -* 11620: Add a new :event:`include-read` for observing and transforming - the content of included files via the :dudir:`include` directive. -* #11627: Restore support for copyright lines of the form ``YYYY`` - when ``SOURCE_DATE_EPOCH`` is set. - -Release 7.2.4 (released Aug 28, 2023) -===================================== - -Bugs fixed ----------- - -* #11618: Fix a regression in the MoveModuleTargets transform, - introduced in #10478 (#9662). -* #11649: linkcheck: Resolve hanging tests for timezones west of London - and incorrect conversion from UTC to offsets from the UNIX epoch. - Patch by Dmitry Shachnev and Adam Turner. - -Release 7.2.3 (released Aug 23, 2023) -===================================== - -Dependencies ------------- - -* #11576: Require sphinxcontrib-serializinghtml 1.1.9. - -Bugs fixed ----------- - -* Fix regression in ``autodoc.Documenter.parse_name()``. -* Fix regression in JSON serialisation. -* #11543: autodoc: Support positional-only parameters in ``classmethod`` methods - when ``autodoc_preserve_defaults`` is ``True``. -* Restore support string methods on path objects. - This is deprecated and will be removed in Sphinx 8. - Use :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings, - or :py:class:`~pathlib.Path`'s methods to work with path objects. - -Release 7.2.2 (released Aug 17, 2023) -===================================== - -Bugs fixed ----------- - -* Fix the signature of the ``StateMachine.insert_input()`` patch, - for when calling with keyword arguments. -* Fixed membership testing (``in``) for the :py:class:`str` interface - of the asset classes (``_CascadingStyleSheet`` and ``_JavaScript``), - which several extensions relied upon. -* Fixed a type error in ``SingleFileHTMLBuilder._get_local_toctree``, - ``includehidden`` may be passed as a string or a boolean. -* Fix ``:noindex:`` for ``PyModule`` and ``JSModule``. - -Release 7.2.1 (released Aug 17, 2023) -===================================== - -Bugs fixed ----------- - -* Restored the the :py:class:`str` interface of the asset classes - (``_CascadingStyleSheet`` and ``_JavaScript``), which several extensions relied upon. - This will be removed in Sphinx 9. -* Restored calls to ``Builder.add_{css,js}_file()``, - which several extensions relied upon. -* Restored the private API ``TocTree.get_toctree_ancestors()``, - which several extensions relied upon. - -Release 7.2.0 (released Aug 17, 2023) -===================================== - -Dependencies ------------- - -* #11511: Drop Python 3.8 support. -* #11576: Require Pygments 2.14 or later. - -Deprecated ----------- - -* #11512: Deprecate ``sphinx.util.md5`` and ``sphinx.util.sha1``. - Use ``hashlib`` instead. -* #11526: Deprecate ``sphinx.testing.path``. - Use ``os.path`` or ``pathlib`` instead. -* #11528: Deprecate ``sphinx.util.split_index_msg`` and ``sphinx.util.split_into``. - Use ``sphinx.util.index_entries.split_index_msg`` instead. -* Deprecate ``sphinx.builders.html.Stylesheet`` - and ``sphinx.builders.html.Javascript``. - Use ``sphinx.application.Sphinx.add_css_file()`` - and ``sphinx.application.Sphinx.add_js_file()`` instead. -* #11582: Deprecate ``sphinx.builders.html.StandaloneHTMLBuilder.css_files`` and - ``sphinx.builders.html.StandaloneHTMLBuilder.script_files``. - Use ``sphinx.application.Sphinx.add_css_file()`` - and ``sphinx.application.Sphinx.add_js_file()`` instead. -* #11459: Deprecate ``sphinx.ext.autodoc.preserve_defaults.get_function_def()``. - Patch by Bénédikt Tran. - -Features added --------------- - -* #11526: Support ``os.PathLike`` types and ``pathlib.Path`` objects - in many more places. -* #5474: coverage: Print summary statistics tables. - Patch by Jorge Leitao. -* #6319: viewcode: Add :confval:`viewcode_line_numbers` to control - whether line numbers are added to rendered source code. - Patch by Ben Krikler. -* #9662: Add the ``:no-typesetting:`` option to suppress textual output - and only create a linkable anchor. - Patch by Latosha Maltba. -* #11221: C++: Support domain objects in the table of contents. - Patch by Rouslan Korneychuk. -* #10938: doctest: Add :confval:`doctest_show_successes` option. - Patch by Trey Hunner. -* #11533: Add ``:no-index:``, ``:no-index-entry:``, and ``:no-contents-entry:``. -* #11572: Improve ``debug`` logging of reasons why files are detected as out of - date. - Patch by Eric Larson. -* #10678: Emit :event:`source-read` events for files read via - the :dudir:`include` directive. - Patch by Halldor Fannar. -* #11570: Use short names when using :pep:`585` built-in generics. - Patch by Riccardo Mori. -* #11300: Improve ``SigElementFallbackTransform`` fallback logic and signature - text elements nodes. See :doc:`the documentation ` for more - details. - Patch by Bénédikt Tran. -* Allow running Sphinx with ``python -m sphinx build ...``. - -Bugs fixed ----------- - -* #11077: graphviz: Fix relative links from within the graph. - Patch by Ralf Grubenmann. -* #11529: Line Block in LaTeX builder outputs spurious empty token. - Patch by Adrian Vollmer. -* #11196: autosummary: Summary line extraction failed with "e.g." -* #10614: Fixed a number of bugs in inheritance diagrams that resulted in - missing or broken links. - Patch by Albert Shih. -* #9428: Exclude substitution definitions when running the ``gettext`` builder. - Patch by Alvin Wong. -* #10795: Raise a descriptive error if ``graphviz_dot`` is falsy. -* #11546: Translated nodes identical to their original text are now marked - with the ``translated=True`` attribute. -* #10049: html: Change "Permalink" to "Link" for title text in link anchors. -* #4225: Relax Pygments parsing on lexing failures. -* #11246: Allow inline links in the first line of a docstring and one-line - type comments ``#: :meta ...:`` when using :mod:`sphinx.ext.napoleon`. - Patch by Bénédikt Tran. -* #10930: Highlight all search terms on the search results page. - Patch by Dmitry Shachnev. -* #11473: Type annotations containing :py:data:`~typing.Literal` enumeration - values now render correctly. - Patch by Bénédikt Tran. -* #11591: Fix support for C coverage in ``sphinx.ext.coverage`` extension. - Patch by Stephen Finucane. -* #11594: HTML Theme: Enhancements to horizontal scrolling on smaller - devices in the ``agogo`` theme. - Patch by Lukas Engelter. -* #11459: Fix support for async and lambda functions in - ``sphinx.ext.autodoc.preserve_defaults``. - Patch by Bénédikt Tran. - -Testing -------- - -* #11577: pytest: Fail tests on "XPASS". -* #11577: pytest: Use "importlib" import mode. -* #11577: pytest: Set PYTHONWARNINGS=error. -* #11577: pytest: Set strict config and strict markers. - -Release 7.1.2 (released Aug 02, 2023) -===================================== - -Bugs fixed ----------- - -* #11542: linkcheck: Properly respect :confval:`linkcheck_anchors` - and do not spuriously report failures to validate anchors. - Patch by James Addison. - -Release 7.1.1 (released Jul 27, 2023) -===================================== - -Bugs fixed ----------- - -* #11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer. - Patch by Bénédikt Tran. - -Release 7.1.0 (released Jul 24, 2023) -===================================== - -Incompatible changes --------------------- - -* Releases are no longer signed, given the `change in PyPI policy`_. - - .. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ - -Deprecated ----------- - -* #11412: Emit warnings on using a deprecated Python-specific index entry type - (namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``, - ``statement``, and ``builtin``) in the :rst:dir:`index` directive, and - set the removal version to Sphinx 9. Patch by Adam Turner. - -Features added --------------- - -* #11415: Add a checksum to JavaScript and CSS asset URIs included within - generated HTML, using the CRC32 algorithm. -* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version - requirement to be specified as ``(major, minor)``. -* #11011: Allow configuring a line-length limit for object signatures, via - :confval:`maximum_signature_line_length` and the domain-specific variants. - If the length of the signature (in characters) is greater than the configured - limit, each parameter in the signature will be split to its own logical line. - This behaviour may also be controlled by options on object description - directives, for example :rst:dir:`py:function:single-line-parameter-list`. - Patch by Thomas Louf, Adam Turner, and Jean-François B. -* #10983: Support for multiline copyright statements in the footer block. - Patch by Stefanie Molin -* ``sphinx.util.display.status_iterator`` now clears the current line - with ANSI control codes, rather than overprinting with space characters. -* #11431: linkcheck: Treat SSL failures as broken links. - Patch by James Addison. -* #11157: Keep the ``translated`` attribute on translated nodes. -* #11451: Improve the traceback displayed when using :option:`sphinx-build -T` - in parallel builds. Patch by Bénédikt Tran -* #11324: linkcheck: Use session-basd HTTP requests. -* #11438: Add support for the :rst:dir:`py:class` and :rst:dir:`py:function` - directives for PEP 695 (generic classes and functions declarations) and - PEP 696 (default type parameters). Multi-line support (#11011) is enabled - for type parameters list and can be locally controlled on object description - directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`. - Patch by Bénédikt Tran. -* #11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis - via :confval:`linkcheck_anchors_ignore_for_url` while - still checking the validity of the page itself. - Patch by Bénédikt Tran -* #1246: Add translation progress statistics and inspection support, - via a new substitution (``|translation progress|``) and a new - configuration variable (:confval:`translation_progress_classes`). - These enable determining the percentage of translated elements within - a document, and the remaining translated and untranslated elements. - -Bugs fixed ----------- - -* Restored the ``footnote-reference`` class that has been removed in - the latest (unreleased) version of Docutils. -* #11486: Use :rfc:`8081` font file MIME types in the EPUB builder. - Using the correct MIME type will prevent warnings from ``epubcheck`` - and will generate a valid EPUB. -* #11435: Use microsecond-resolution timestamps for outdated file detection - in ``BuildEnvironment.get_outdated_files``. -* #11437: Top-level headings starting with a reStructuredText role - now render properly when :confval:`rst_prolog` is set. - Previously, a file starting with the below would have - improperly rendered due to where the prologue text - was inserted into the document. - - .. code:: rst - - :mod:`lobster` -- The lobster module - ==================================== - - ... - - Patch by Bénédikt Tran. -* #11337: Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None`` - or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz) - -Testing -------- - -* #11345: Always delete ``docutils.conf`` in test directories when running - ``SphinxTestApp.cleanup()``. - -Release 7.0.1 (released May 12, 2023) -===================================== - -Dependencies ------------- - -* #11411: Support `Docutils 0.20`_. Patch by Adam Turner. - -.. _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04 - -Bugs fixed ----------- - -* #11418: Clean up remaining references to ``sphinx.setup_command`` - following the removal of support for setuptools. - Patch by Willem Mulder. - -Release 7.0.0 (released Apr 29, 2023) -===================================== - -Incompatible changes --------------------- - -* #11359: Remove long-deprecated aliases for ``MecabSplitter`` and - ``DefaultSplitter`` in ``sphinx.search.ja``. -* #11360: Remove deprecated ``make_old_id`` functions in domain object - description classes. -* #11363: Remove the Setuptools integration (``build_sphinx`` hook in - ``setup.py``). -* #11364: Remove deprecated ``sphinx.ext.napoleon.iterators`` module. -* #11365: Remove support for the ``jsdump`` format in ``sphinx.search``. -* #11366: Make ``locale`` a required argument to - ``sphinx.util.i18n.format_date()``. -* #11370: Remove deprecated ``sphinx.util.stemmer`` module. -* #11371: Remove deprecated ``sphinx.pycode.ast.parse()`` function. -* #11372: Remove deprecated ``sphinx.io.read_doc()`` function. -* #11373: Removed deprecated ``sphinx.util.get_matching_files()`` function. -* #11378: Remove deprecated ``sphinx.util.docutils.is_html5_writer_available()`` - function. -* #11379: Make the ``env`` argument to ``Builder`` subclasses required. -* #11380: autosummary: Always emit grouped import exceptions. -* #11381: Remove deprecated ``style`` key for HTML templates. -* #11382: Remove deprecated ``sphinx.writers.latex.LaTeXTranslator.docclasses`` - attribute. -* #11383: Remove deprecated ``sphinx.builders.html.html5_ready`` and - ``sphinx.builders.html.HTMLTranslator`` attributes. -* #11385: Remove support for HTML 4 output. - -Release 6.2.1 (released Apr 25, 2023) -===================================== - -Bugs fixed ----------- - -* #11355: Revert the default type of :confval:`nitpick_ignore` and - :confval:`nitpick_ignore_regex` to ``list``. - -Release 6.2.0 (released Apr 23, 2023) -===================================== - -Dependencies ------------- - -* Require Docutils 0.18.1 or greater. - -Incompatible changes --------------------- - -* LaTeX: removal of some internal TeX ``\dimen`` registers (not previously - publicly documented) as per 5.1.0 code comments in ``sphinx.sty``: - ``\sphinxverbatimsep``, ``\sphinxverbatimborder``, ``\sphinxshadowsep``, - ``\sphinxshadowsize``, and ``\sphinxshadowrule``. (refs: #11105) -* Remove ``.egg`` support from pycode ``ModuleAnalyser``; Python eggs are a - now-obsolete binary distribution format -* #11089: Remove deprecated code in ``sphinx.builders.linkcheck``. - Patch by Daniel Eades -* Remove internal-only ``sphinx.locale.setlocale`` - -Deprecated ----------- - -* #11247: Deprecate the legacy ``intersphinx_mapping`` format -* ``sphinx.util.osutil.cd`` is deprecated in favour of ``contextlib.chdir``. - -Features added --------------- - -* #11277: :rst:dir:`autoproperty` allows the return type to be specified as - a type comment (e.g., ``# type: () -> int``). Patch by Bénédikt Tran -* #10811: Autosummary: extend ``__all__`` to imported members for template rendering - when option ``autosummary_ignore_module_all`` is set to ``False``. Patch by - Clement Pinard -* #11147: Add a ``content_offset`` parameter to ``nested_parse_with_titles()``, - allowing for correct line numbers during nested parsing. - Patch by Jeremy Maitin-Shepard -* Update to Unicode CLDR 42 -* Add a ``--jobs`` synonym for ``-j``. Patch by Hugo van Kemenade -* LaTeX: a command ``\sphinxbox`` for styling text elements with a (possibly - rounded) box, optional background color and shadow, has been added. - See :ref:`sphinxbox`. (refs: #11224) -* LaTeX: add ``\sphinxstylenotetitle``, ..., ``\sphinxstylewarningtitle``, ..., - for an extra layer of mark-up freeing up ``\sphinxstrong`` for other uses. - See :ref:`latex-macros`. (refs: #11267) -* LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can - now each be styled as the other admonitions, i.e. possibly with a background - color, individual border widths and paddings, possibly rounded corners, and - optional shadow. See :ref:`additionalcss`. (refs: #11234) -* LaTeX: admonitions and :dudir:`topic` (and - :dudir:`contents `) directives, and not only - :rst:dir:`code-block`, support ``box-decoration-break=slice``. -* LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: #11243) -* LaTeX: new options ``noteTextColor``, ``noteTeXextras`` et al. - See :ref:`additionalcss`. -* LaTeX: support elliptical corners in rounded boxes. (refs: #11254) -* #11150: Include source location in highlighting warnings, when lexing fails. - Patch by Jeremy Maitin-Shepard -* #11281: Support for :confval:`imgmath_latex` ``= 'tectonic'`` or - ``= 'xelatex'``. Patch by Dimitar Dimitrov -* #11109, #9643: Add :confval:`python_display_short_literal_types` option for - condensed rendering of ``Literal`` types. - -Bugs fixed ----------- - -* #11079: LaTeX: figures with align attribute may disappear and strangely impact - following lists -* #11093: LaTeX: fix "multiply-defined references" PDF build warnings when one or - more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule` - directive. Patch by Bénédikt Tran (picnixz) -* #11110: LaTeX: Figures go missing from latex pdf if their files have the same - base name and they use a post transform. Patch by aaron-cooper -* LaTeX: fix potential color leak from shadow to border of rounded boxes, if - shadow color is set but border color is not -* LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames - respective to contents (when using rounded corners) -* #11235: LaTeX: added ``\color`` in topic (or admonition) contents may cause color - leak to the shadow and border at a page break -* #11264: LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso` - directive in French -* #11268: LaTeX: longtable with left alignment breaks out of current list - indentation context in PDF. Thanks to picnixz. -* #11274: LaTeX: external links are not properly escaped for ``\sphinxupquote`` - compatibility -* #11147: Fix source file/line number info in object description content and in - other uses of ``nested_parse_with_titles``. Patch by Jeremy Maitin-Shepard. -* #11192: Restore correct parallel search index building. - Patch by Jeremy Maitin-Shepard -* Use the new Transifex ``tx`` client - -Testing -------- - -* Fail testing when any Python warnings are emitted -* Migrate remaining ``unittest.TestCase`` style test functions to pytest style -* Remove tests that rely on setuptools - -Release 6.1.3 (released Jan 10, 2023) -===================================== - -Bugs fixed ----------- - -* #11116: Reverted to previous Sphinx 5 node copying method -* #11117: Reverted changes to parallel image processing from Sphinx 6.1.0 -* #11119: Supress ``ValueError`` in the ``linkcheck`` builder - -Release 6.1.2 (released Jan 07, 2023) -===================================== - -Bugs fixed ----------- - -* #11101: LaTeX: ``div.topic_padding`` key of sphinxsetup documented at 5.1.0 was - implemented with name ``topic_padding`` -* #11099: LaTeX: ``shadowrule`` key of sphinxsetup causes PDF build to crash - since Sphinx 5.1.0 -* #11096: LaTeX: ``shadowsize`` key of sphinxsetup causes PDF build to crash - since Sphinx 5.1.0 -* #11095: LaTeX: shadow of :dudir:`topic` and :dudir:`contents ` - boxes not in page margin since Sphinx 5.1.0 -* #11100: Fix copying images when running under parallel mode. - -Release 6.1.1 (released Jan 05, 2023) -===================================== - -Bugs fixed ----------- - -* #11091: Fix ``util.nodes.apply_source_workaround`` for ``literal_block`` nodes - with no source information in the node or the node's parents. - -Release 6.1.0 (released Jan 05, 2023) -===================================== - -Dependencies ------------- - -* Adopted the `Ruff`_ code linter. - - .. _Ruff: https://github.com/charliermarsh/ruff - -Incompatible changes --------------------- - -* #10979: gettext: Removed support for pluralisation in ``get_translation``. - This was unused and complicated other changes to ``sphinx.locale``. - -Deprecated ----------- - -* ``sphinx.util`` functions: - - * Renamed ``sphinx.util.typing.stringify()`` - to ``sphinx.util.typing.stringify_annotation()`` - * Moved ``sphinx.util.xmlname_checker()`` - to ``sphinx.builders.epub3._XML_NAME_PATTERN`` - - Moved to ``sphinx.util.display``: - - * ``sphinx.util.status_iterator`` - * ``sphinx.util.display_chunk`` - * ``sphinx.util.SkipProgressMessage`` - * ``sphinx.util.progress_message`` - - Moved to ``sphinx.util.http_date``: - - * ``sphinx.util.epoch_to_rfc1123`` - * ``sphinx.util.rfc1123_to_epoch`` - - Moved to ``sphinx.util.exceptions``: - - * ``sphinx.util.save_traceback`` - * ``sphinx.util.format_exception_cut_frames`` - -Features added --------------- - -* Cache doctrees in the build environment during the writing phase. -* Make all writing phase tasks support parallel execution. -* #11072: Use PEP 604 (``X | Y``) display conventions for ``typing.Optional`` - and ``typing.Optional`` types within the Python domain and autodoc. -* #10700: autodoc: Document ``typing.NewType()`` types as classes rather than - 'data'. -* Cache doctrees between the reading and writing phases. - -Bugs fixed ----------- - -* #10962: HTML: Fix the multi-word key name lookup table. -* Fixed support for Python 3.12 alpha 3 (changes in the ``enum`` module). -* #11069: HTML Theme: Removed outdated "shortcut" link relation keyword. -* #10952: Properly terminate parallel processes on programme interuption. -* #10988: Speed up ``TocTree.resolve()`` through more efficient copying. -* #6744: LaTeX: support for seealso directive should be via an environment - to allow styling. -* #11074: LaTeX: Can't change sphinxnote to use sphinxheavybox starting with - 5.1.0 - -Release 6.0.1 (released Jan 05, 2023) -===================================== - -Dependencies ------------- - -* Require Pygments 2.13 or later. - -Bugs fixed ----------- - -* #10944: imgmath: Fix resolving image paths for files in nested folders. - -Release 6.0.0 (released Dec 29, 2022) -===================================== - -Dependencies ------------- - -* #10468: Drop Python 3.6 support -* #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and - Docutils 0.17 support. Patch by Adam Turner - -Incompatible changes --------------------- - -* #7405: Removed the jQuery and underscore.js JavaScript frameworks. - - These frameworks are no longer be automatically injected into themes from - Sphinx 6.0. If you develop a theme or extension that uses the - ``jQuery``, ``$``, or ``$u`` global objects, you need to update your - JavaScript to modern standards, or use the mitigation below. - - The first option is to use the sphinxcontrib.jquery_ extension, which has been - developed by the Sphinx team and contributors. To use this, add - ``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call - ``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme - or extension. - - The second option is to manually ensure that the frameworks are present. - To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and - ``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory, - and add the following to your ``layout.html``: - - .. code-block:: html+jinja - - {%- block scripts %} - - - {{ super() }} - {%- endblock %} - - .. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/ - - Patch by Adam Turner. -* #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See - :ref:`dev-deprecated-apis` for details. Patch by Adam Turner. -* #10901: C Domain: Remove support for parsing pre-v3 style type directives and - roles. Also remove associated configuration variables ``c_allow_pre_v3`` and - ``c_warn_on_allowed_pre_v3``. Patch by Adam Turner. - -Features added --------------- - -* #10924: LaTeX: adopt better looking defaults for tables and code-blocks. - See :confval:`latex_table_style` and the ``pre_border-radius`` and - ``pre_background-TeXcolor`` :ref:`additionalcss` for the former defaults - and how to re-enact them if desired. - -Bugs fixed ----------- - -* #10984: LaTeX: Document :confval:`latex_additional_files` behavior for files - with ``.tex`` extension. - -Release 5.3.0 (released Oct 16, 2022) -===================================== - -* #10759: LaTeX: add :confval:`latex_table_style` and support the - ``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles. - (thanks to Stefan Wiehler for initial pull requests #6666, #6671) -* #10840: One can cross-reference including an option value like ``:option:`--module=foobar```, - ``:option:`--module[=foobar]``` or ``:option:`--module foobar```. - Patch by Martin Liska. -* #10881: autosectionlabel: Record the generated section label to the debug log. -* #10268: Correctly URI-escape image filenames. -* #10887: domains: Allow sections in all the content of all object description - directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner - -Release 5.2.3 (released Sep 30, 2022) -===================================== - -* #10878: Fix base64 image embedding in ``sphinx.ext.imgmath`` -* #10886: Add ``:nocontentsentry:`` flag and global domain table of contents - entry control option. Patch by Adam Turner - -Release 5.2.2 (released Sep 27, 2022) -===================================== - -* #10872: Restore link targets for autodoc modules to the top of content. - Patch by Dominic Davis-Foster. - -Release 5.2.1 (released Sep 25, 2022) -===================================== - -Bugs fixed ----------- - -* #10861: Always normalise the ``pycon3`` lexer to ``pycon``. -* Fix using ``sphinx.ext.autosummary`` with modules containing titles in the - module-level docstring. - -Release 5.2.0.post0 (released Sep 24, 2022) -=========================================== - -* Recreated source tarballs for Debian maintainers. - -Release 5.2.0 (released Sep 24, 2022) -===================================== - -Dependencies ------------- - -* #10356: Sphinx now uses declarative metadata with ``pyproject.toml`` to - create packages, using PyPA's ``flit`` project as a build backend. Patch by - Adam Turner. - -Deprecated ----------- - -* #10843: Support for HTML 4 output. Patch by Adam Turner. - -Features added --------------- - -* #10738: napoleon: Add support for docstring types using 'of', like - ``type of type``. Example: ``tuple of int``. -* #10286: C++, support requires clauses not just between the template - parameter lists and the declaration. -* #10755: linkcheck: Check the source URL of raw directives that use the ``url`` - option. -* #10781: Allow :rst:role:`ref` role to be used with definitions and fields. -* #10717: HTML Search: Increase priority for full title and - subtitle matches in search results -* #10718: HTML Search: Save search result score to the HTML element for debugging -* #10673: Make toctree accept 'genindex', 'modindex' and 'search' docnames -* #6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner -* #6692: HTML Search: Include explicit :rst:dir:`index` directive index entries - in the search index and search results. Patch by Adam Turner -* #10816: imgmath: Allow embedding images in HTML as base64 -* #10854: HTML Search: Use browser localstorage for highlight control, stop - storing highlight parameters in URL query strings. Patch by Adam Turner. - -Bugs fixed ----------- - -* #10723: LaTeX: 5.1.0 has made the 'sphinxsetup' ``verbatimwithframe=false`` - become without effect. -* #10257: C++, ensure consistent non-specialization template argument - representation. -* #10729: C++, fix parsing of certain non-type template parameter packs. -* #10715: Revert #10520: "Fix" use of sidebar classes in ``agogo.css_t`` - -Release 5.1.1 (released Jul 26, 2022) -===================================== - -Bugs fixed ----------- - -* #10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean`` - iterator implementation. -* #10702: Restore compatability with third-party builders. - -Release 5.1.0 (released Jul 24, 2022) -===================================== - -Dependencies ------------- - -* #10656: Support `Docutils 0.19`_. Patch by Adam Turner. - -.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05 - -Deprecated ----------- - -* #10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``. - Patch by Adam Turner. -* #9856: Deprecated ``sphinx.ext.napoleon.iterators``. - -Features added --------------- - -* #10444: html theme: Allow specifying multiple CSS files through the ``stylesheet`` - setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings. -* #10366: std domain: Add support for emphasising placeholders in :rst:dir:`option` - directives through a new :confval:`option_emphasise_placeholders` configuration - option. -* #10439: std domain: Use the repr of some variables when displaying warnings, - making whitespace issues easier to identify. -* #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by - Pradyun Gedam. -* #10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' ` - keys allow to configure four separate border-widths, four paddings, four - corner radii, a shadow (possibly inset), colours for border, background, shadow - for each of the code-block, topic, attention, caution, danger, error and warning - directives. -* #10655: LaTeX: Explain non-standard encoding in LatinRules.xdy -* #10599: HTML Theme: Wrap consecutive footnotes in an ``