summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--AUTHORS95
-rw-r--r--CHANGES9019
-rw-r--r--CODE_OF_CONDUCT78
-rw-r--r--EXAMPLES479
-rw-r--r--LICENSE67
-rw-r--r--PKG-INFO147
-rw-r--r--README.rst63
-rw-r--r--doc/Makefile20
-rw-r--r--doc/_static/Makefile6
-rw-r--r--doc/_static/bookcover.pngbin0 -> 27523 bytes
-rw-r--r--doc/_static/conf.py.txt346
-rw-r--r--doc/_static/favicon.svg8
-rw-r--r--doc/_static/more.pngbin0 -> 1351 bytes
-rw-r--r--doc/_static/sphinx.pngbin0 -> 34213 bytes
-rw-r--r--doc/_static/themes/agogo.pngbin0 -> 25792 bytes
-rw-r--r--doc/_static/themes/alabaster.pngbin0 -> 32356 bytes
-rw-r--r--doc/_static/themes/bizstyle.pngbin0 -> 27139 bytes
-rw-r--r--doc/_static/themes/classic.pngbin0 -> 39927 bytes
-rw-r--r--doc/_static/themes/fullsize/agogo.pngbin0 -> 56954 bytes
-rw-r--r--doc/_static/themes/fullsize/alabaster.pngbin0 -> 40248 bytes
-rw-r--r--doc/_static/themes/fullsize/bizstyle.pngbin0 -> 75192 bytes
-rw-r--r--doc/_static/themes/fullsize/classic.pngbin0 -> 72597 bytes
-rw-r--r--doc/_static/themes/fullsize/haiku.pngbin0 -> 84200 bytes
-rw-r--r--doc/_static/themes/fullsize/nature.pngbin0 -> 32266 bytes
-rw-r--r--doc/_static/themes/fullsize/pyramid.pngbin0 -> 102717 bytes
-rw-r--r--doc/_static/themes/fullsize/scrolls.pngbin0 -> 88111 bytes
-rw-r--r--doc/_static/themes/fullsize/sphinx_rtd_theme.pngbin0 -> 39411 bytes
-rw-r--r--doc/_static/themes/fullsize/sphinxdoc.pngbin0 -> 84439 bytes
-rw-r--r--doc/_static/themes/fullsize/traditional.pngbin0 -> 91744 bytes
-rw-r--r--doc/_static/themes/haiku.pngbin0 -> 43184 bytes
-rw-r--r--doc/_static/themes/nature.pngbin0 -> 28536 bytes
-rw-r--r--doc/_static/themes/pyramid.pngbin0 -> 38805 bytes
-rw-r--r--doc/_static/themes/scrolls.pngbin0 -> 27800 bytes
-rw-r--r--doc/_static/themes/sphinx_rtd_theme.pngbin0 -> 29138 bytes
-rw-r--r--doc/_static/themes/sphinxdoc.pngbin0 -> 30225 bytes
-rw-r--r--doc/_static/themes/traditional.pngbin0 -> 32258 bytes
-rw-r--r--doc/_static/translation.pngbin0 -> 16371 bytes
-rw-r--r--doc/_static/translation.puml16
-rw-r--r--doc/_static/translation.svg42
-rw-r--r--doc/_static/tutorial/lumache-autosummary.pngbin0 -> 26500 bytes
-rw-r--r--doc/_static/tutorial/lumache-first-light.pngbin0 -> 52126 bytes
-rw-r--r--doc/_static/tutorial/lumache-furo.pngbin0 -> 51223 bytes
-rw-r--r--doc/_static/tutorial/lumache-py-function-full.pngbin0 -> 71741 bytes
-rw-r--r--doc/_static/tutorial/lumache-py-function.pngbin0 -> 41828 bytes
-rw-r--r--doc/_templates/contents.html8
-rw-r--r--doc/_themes/sphinx13/layout.html60
-rw-r--r--doc/_themes/sphinx13/static/sphinx13.css362
-rw-r--r--doc/_themes/sphinx13/static/sphinxheader.pngbin0 -> 11719 bytes
-rw-r--r--doc/_themes/sphinx13/theme.conf4
-rw-r--r--doc/authors.rst9
-rw-r--r--doc/changes.rst22
-rw-r--r--doc/conf.py244
-rw-r--r--doc/development/builders.rst34
-rw-r--r--doc/development/index.rst24
-rw-r--r--doc/development/overview.rst32
-rw-r--r--doc/development/templating.rst478
-rw-r--r--doc/development/theming.rst342
-rw-r--r--doc/development/tutorials/autodoc_ext.rst141
-rw-r--r--doc/development/tutorials/examples/README.rst11
-rw-r--r--doc/development/tutorials/examples/autodoc_intenum.py58
-rw-r--r--doc/development/tutorials/examples/helloworld.py19
-rw-r--r--doc/development/tutorials/examples/recipe.py159
-rw-r--r--doc/development/tutorials/examples/todo.py135
-rw-r--r--doc/development/tutorials/helloworld.rst189
-rw-r--r--doc/development/tutorials/index.rst17
-rw-r--r--doc/development/tutorials/recipe.rst227
-rw-r--r--doc/development/tutorials/todo.rst367
-rw-r--r--doc/examples.rst5
-rw-r--r--doc/extdev/appapi.rst473
-rw-r--r--doc/extdev/builderapi.rst46
-rw-r--r--doc/extdev/collectorapi.rst9
-rw-r--r--doc/extdev/deprecated.rst1911
-rw-r--r--doc/extdev/domainapi.rst32
-rw-r--r--doc/extdev/envapi.rst58
-rw-r--r--doc/extdev/i18n.rst97
-rw-r--r--doc/extdev/index.rst218
-rw-r--r--doc/extdev/logging.rst66
-rw-r--r--doc/extdev/markupapi.rst152
-rw-r--r--doc/extdev/nodes.rst103
-rw-r--r--doc/extdev/parserapi.rst38
-rw-r--r--doc/extdev/projectapi.rst9
-rw-r--r--doc/extdev/utils.rst37
-rw-r--r--doc/faq.rst354
-rw-r--r--doc/glossary.rst103
-rw-r--r--doc/index.rst117
-rw-r--r--doc/internals/code-of-conduct.rst5
-rw-r--r--doc/internals/contributing.rst332
-rw-r--r--doc/internals/index.rst15
-rw-r--r--doc/internals/organization.rst56
-rw-r--r--doc/internals/release-process.rst125
-rw-r--r--doc/latex.rst1841
-rw-r--r--doc/make.bat32
-rw-r--r--doc/man/index.rst22
-rw-r--r--doc/man/sphinx-apidoc.rst171
-rw-r--r--doc/man/sphinx-autogen.rst97
-rw-r--r--doc/man/sphinx-build.rst355
-rw-r--r--doc/man/sphinx-quickstart.rst169
-rw-r--r--doc/support.rst20
-rw-r--r--doc/tutorial/automatic-doc-generation.rst165
-rw-r--r--doc/tutorial/deploying.rst281
-rw-r--r--doc/tutorial/describing-code.rst276
-rw-r--r--doc/tutorial/end.rst6
-rw-r--r--doc/tutorial/first-steps.rst92
-rw-r--r--doc/tutorial/getting-started.rst120
-rw-r--r--doc/tutorial/index.rst39
-rw-r--r--doc/tutorial/more-sphinx-customization.rst78
-rw-r--r--doc/tutorial/narrative-documentation.rst130
-rw-r--r--doc/usage/advanced/intl.rst372
-rw-r--r--doc/usage/advanced/websupport/api.rst80
-rw-r--r--doc/usage/advanced/websupport/index.rst16
-rw-r--r--doc/usage/advanced/websupport/quickstart.rst255
-rw-r--r--doc/usage/advanced/websupport/searchadapters.rst49
-rw-r--r--doc/usage/advanced/websupport/storagebackends.rst49
-rw-r--r--doc/usage/builders/index.rst565
-rw-r--r--doc/usage/configuration.rst3094
-rw-r--r--doc/usage/extensions/autodoc.rst853
-rw-r--r--doc/usage/extensions/autosectionlabel.rst56
-rw-r--r--doc/usage/extensions/autosummary.rst364
-rw-r--r--doc/usage/extensions/coverage.rst99
-rw-r--r--doc/usage/extensions/doctest.rst385
-rw-r--r--doc/usage/extensions/duration.rst11
-rw-r--r--doc/usage/extensions/example_google.py309
-rw-r--r--doc/usage/extensions/example_google.rst17
-rw-r--r--doc/usage/extensions/example_numpy.py350
-rw-r--r--doc/usage/extensions/example_numpy.rst17
-rw-r--r--doc/usage/extensions/extlinks.rst69
-rw-r--r--doc/usage/extensions/githubpages.rst16
-rw-r--r--doc/usage/extensions/graphviz.rst239
-rw-r--r--doc/usage/extensions/ifconfig.rst38
-rw-r--r--doc/usage/extensions/imgconverter.rst55
-rw-r--r--doc/usage/extensions/index.rst81
-rw-r--r--doc/usage/extensions/inheritance.rst174
-rw-r--r--doc/usage/extensions/intersphinx.rst250
-rw-r--r--doc/usage/extensions/linkcode.rst51
-rw-r--r--doc/usage/extensions/math.rst320
-rw-r--r--doc/usage/extensions/napoleon.rst574
-rw-r--r--doc/usage/extensions/todo.rst62
-rw-r--r--doc/usage/extensions/viewcode.rst106
-rw-r--r--doc/usage/index.rst20
-rw-r--r--doc/usage/installation.rst282
-rw-r--r--doc/usage/markdown.rst52
-rw-r--r--doc/usage/quickstart.rst348
-rw-r--r--doc/usage/restructuredtext/basics.rst631
-rw-r--r--doc/usage/restructuredtext/directives.rst1311
-rw-r--r--doc/usage/restructuredtext/domains.rst2303
-rw-r--r--doc/usage/restructuredtext/field-lists.rst78
-rw-r--r--doc/usage/restructuredtext/index.rst24
-rw-r--r--doc/usage/restructuredtext/roles.rst536
-rw-r--r--doc/usage/theming.rst364
-rw-r--r--pyproject.toml463
-rw-r--r--sphinx/__init__.py54
-rw-r--r--sphinx/__main__.py7
-rw-r--r--sphinx/addnodes.py605
-rw-r--r--sphinx/application.py1371
-rw-r--r--sphinx/builders/__init__.py667
-rw-r--r--sphinx/builders/_epub_base.py710
-rw-r--r--sphinx/builders/changes.py161
-rw-r--r--sphinx/builders/dirhtml.py53
-rw-r--r--sphinx/builders/dummy.py48
-rw-r--r--sphinx/builders/epub3.py301
-rw-r--r--sphinx/builders/gettext.py306
-rw-r--r--sphinx/builders/html/__init__.py1399
-rw-r--r--sphinx/builders/html/_assets.py146
-rw-r--r--sphinx/builders/html/transforms.py86
-rw-r--r--sphinx/builders/latex/__init__.py551
-rw-r--r--sphinx/builders/latex/constants.py210
-rw-r--r--sphinx/builders/latex/nodes.py37
-rw-r--r--sphinx/builders/latex/theming.py135
-rw-r--r--sphinx/builders/latex/transforms.py642
-rw-r--r--sphinx/builders/latex/util.py48
-rw-r--r--sphinx/builders/linkcheck.py641
-rw-r--r--sphinx/builders/manpage.py127
-rw-r--r--sphinx/builders/singlehtml.py202
-rw-r--r--sphinx/builders/texinfo.py229
-rw-r--r--sphinx/builders/text.py94
-rw-r--r--sphinx/builders/xml.py123
-rw-r--r--sphinx/cmd/__init__.py1
-rw-r--r--sphinx/cmd/build.py345
-rw-r--r--sphinx/cmd/make_mode.py181
-rw-r--r--sphinx/cmd/quickstart.py617
-rw-r--r--sphinx/config.py561
-rw-r--r--sphinx/deprecation.py66
-rw-r--r--sphinx/directives/__init__.py373
-rw-r--r--sphinx/directives/code.py482
-rw-r--r--sphinx/directives/other.py443
-rw-r--r--sphinx/directives/patches.py189
-rw-r--r--sphinx/domains/__init__.py406
-rw-r--r--sphinx/domains/c.py3906
-rw-r--r--sphinx/domains/changeset.py161
-rw-r--r--sphinx/domains/citation.py154
-rw-r--r--sphinx/domains/cpp.py8233
-rw-r--r--sphinx/domains/index.py126
-rw-r--r--sphinx/domains/javascript.py508
-rw-r--r--sphinx/domains/math.py152
-rw-r--r--sphinx/domains/python.py1769
-rw-r--r--sphinx/domains/rst.py299
-rw-r--r--sphinx/domains/std.py1123
-rw-r--r--sphinx/environment/__init__.py779
-rw-r--r--sphinx/environment/adapters/__init__.py1
-rw-r--r--sphinx/environment/adapters/asset.py15
-rw-r--r--sphinx/environment/adapters/indexentries.py187
-rw-r--r--sphinx/environment/adapters/toctree.py520
-rw-r--r--sphinx/environment/collectors/__init__.py72
-rw-r--r--sphinx/environment/collectors/asset.py147
-rw-r--r--sphinx/environment/collectors/dependencies.py57
-rw-r--r--sphinx/environment/collectors/metadata.py70
-rw-r--r--sphinx/environment/collectors/title.py61
-rw-r--r--sphinx/environment/collectors/toctree.py355
-rw-r--r--sphinx/errors.py127
-rw-r--r--sphinx/events.py121
-rw-r--r--sphinx/ext/__init__.py1
-rw-r--r--sphinx/ext/apidoc.py492
-rw-r--r--sphinx/ext/autodoc/__init__.py2850
-rw-r--r--sphinx/ext/autodoc/directive.py151
-rw-r--r--sphinx/ext/autodoc/importer.py342
-rw-r--r--sphinx/ext/autodoc/mock.py198
-rw-r--r--sphinx/ext/autodoc/preserve_defaults.py199
-rw-r--r--sphinx/ext/autodoc/type_comment.py140
-rw-r--r--sphinx/ext/autodoc/typehints.py219
-rw-r--r--sphinx/ext/autosectionlabel.py69
-rw-r--r--sphinx/ext/autosummary/__init__.py847
-rw-r--r--sphinx/ext/autosummary/generate.py754
-rw-r--r--sphinx/ext/autosummary/templates/autosummary/base.rst5
-rw-r--r--sphinx/ext/autosummary/templates/autosummary/class.rst29
-rw-r--r--sphinx/ext/autosummary/templates/autosummary/module.rst60
-rw-r--r--sphinx/ext/coverage.py400
-rw-r--r--sphinx/ext/doctest.py575
-rw-r--r--sphinx/ext/duration.py92
-rw-r--r--sphinx/ext/extlinks.py125
-rw-r--r--sphinx/ext/githubpages.py57
-rw-r--r--sphinx/ext/graphviz.py467
-rw-r--r--sphinx/ext/ifconfig.py81
-rw-r--r--sphinx/ext/imgconverter.py94
-rw-r--r--sphinx/ext/imgmath.py407
-rw-r--r--sphinx/ext/inheritance_diagram.py494
-rw-r--r--sphinx/ext/intersphinx.py742
-rw-r--r--sphinx/ext/linkcode.py77
-rw-r--r--sphinx/ext/mathjax.py126
-rw-r--r--sphinx/ext/napoleon/__init__.py474
-rw-r--r--sphinx/ext/napoleon/docstring.py1363
-rw-r--r--sphinx/ext/todo.py246
-rw-r--r--sphinx/ext/viewcode.py361
-rw-r--r--sphinx/extension.py82
-rw-r--r--sphinx/highlighting.py199
-rw-r--r--sphinx/io.py189
-rw-r--r--sphinx/jinja2glue.py221
-rw-r--r--sphinx/locale/.tx/config7
-rw-r--r--sphinx/locale/__init__.py231
-rw-r--r--sphinx/locale/ar/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ar/LC_MESSAGES/sphinx.mobin0 -> 7494 bytes
-rw-r--r--sphinx/locale/ar/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/bg/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/bg/LC_MESSAGES/sphinx.mobin0 -> 492 bytes
-rw-r--r--sphinx/locale/bg/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/bn/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/bn/LC_MESSAGES/sphinx.mobin0 -> 7591 bytes
-rw-r--r--sphinx/locale/bn/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/ca/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ca/LC_MESSAGES/sphinx.mobin0 -> 84364 bytes
-rw-r--r--sphinx/locale/ca/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/cak/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/cak/LC_MESSAGES/sphinx.mobin0 -> 2391 bytes
-rw-r--r--sphinx/locale/cak/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/cs/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/cs/LC_MESSAGES/sphinx.mobin0 -> 7797 bytes
-rw-r--r--sphinx/locale/cs/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/cy/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/cy/LC_MESSAGES/sphinx.mobin0 -> 5686 bytes
-rw-r--r--sphinx/locale/cy/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/da/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/da/LC_MESSAGES/sphinx.mobin0 -> 12266 bytes
-rw-r--r--sphinx/locale/da/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/de/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/de/LC_MESSAGES/sphinx.mobin0 -> 10680 bytes
-rw-r--r--sphinx/locale/de/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/de_DE/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/de_DE/LC_MESSAGES/sphinx.mobin0 -> 505 bytes
-rw-r--r--sphinx/locale/de_DE/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/el/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/el/LC_MESSAGES/sphinx.mobin0 -> 80411 bytes
-rw-r--r--sphinx/locale/el/LC_MESSAGES/sphinx.po3697
-rw-r--r--sphinx/locale/en_DE/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/en_DE/LC_MESSAGES/sphinx.mobin0 -> 506 bytes
-rw-r--r--sphinx/locale/en_DE/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/en_FR/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/en_FR/LC_MESSAGES/sphinx.mobin0 -> 462 bytes
-rw-r--r--sphinx/locale/en_FR/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/en_GB/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/en_GB/LC_MESSAGES/sphinx.mobin0 -> 75590 bytes
-rw-r--r--sphinx/locale/en_GB/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/en_HK/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/en_HK/LC_MESSAGES/sphinx.mobin0 -> 508 bytes
-rw-r--r--sphinx/locale/en_HK/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/eo/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/eo/LC_MESSAGES/sphinx.mobin0 -> 1864 bytes
-rw-r--r--sphinx/locale/eo/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/es/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/es/LC_MESSAGES/sphinx.mobin0 -> 80907 bytes
-rw-r--r--sphinx/locale/es/LC_MESSAGES/sphinx.po3703
-rw-r--r--sphinx/locale/es_CO/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/es_CO/LC_MESSAGES/sphinx.mobin0 -> 546 bytes
-rw-r--r--sphinx/locale/es_CO/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/et/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/et/LC_MESSAGES/sphinx.mobin0 -> 32776 bytes
-rw-r--r--sphinx/locale/et/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/eu/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/eu/LC_MESSAGES/sphinx.mobin0 -> 6505 bytes
-rw-r--r--sphinx/locale/eu/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/fa/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/fa/LC_MESSAGES/sphinx.mobin0 -> 97001 bytes
-rw-r--r--sphinx/locale/fa/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/fi/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/fi/LC_MESSAGES/sphinx.mobin0 -> 2912 bytes
-rw-r--r--sphinx/locale/fi/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/fr/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/fr/LC_MESSAGES/sphinx.mobin0 -> 83168 bytes
-rw-r--r--sphinx/locale/fr/LC_MESSAGES/sphinx.po3722
-rw-r--r--sphinx/locale/fr_FR/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/fr_FR/LC_MESSAGES/sphinx.mobin0 -> 555 bytes
-rw-r--r--sphinx/locale/fr_FR/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/gl/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/gl/LC_MESSAGES/sphinx.mobin0 -> 4716 bytes
-rw-r--r--sphinx/locale/gl/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/he/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/he/LC_MESSAGES/sphinx.mobin0 -> 4822 bytes
-rw-r--r--sphinx/locale/he/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/hi/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/hi/LC_MESSAGES/sphinx.mobin0 -> 96953 bytes
-rw-r--r--sphinx/locale/hi/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/hi_IN/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/hi_IN/LC_MESSAGES/sphinx.mobin0 -> 502 bytes
-rw-r--r--sphinx/locale/hi_IN/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/hr/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/hr/LC_MESSAGES/sphinx.mobin0 -> 16384 bytes
-rw-r--r--sphinx/locale/hr/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/hu/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/hu/LC_MESSAGES/sphinx.mobin0 -> 10971 bytes
-rw-r--r--sphinx/locale/hu/LC_MESSAGES/sphinx.po3700
-rw-r--r--sphinx/locale/id/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/id/LC_MESSAGES/sphinx.mobin0 -> 60268 bytes
-rw-r--r--sphinx/locale/id/LC_MESSAGES/sphinx.po3700
-rw-r--r--sphinx/locale/is/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/is/LC_MESSAGES/sphinx.mobin0 -> 2614 bytes
-rw-r--r--sphinx/locale/is/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/it/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/it/LC_MESSAGES/sphinx.mobin0 -> 10036 bytes
-rw-r--r--sphinx/locale/it/LC_MESSAGES/sphinx.po3700
-rw-r--r--sphinx/locale/ja/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ja/LC_MESSAGES/sphinx.mobin0 -> 85691 bytes
-rw-r--r--sphinx/locale/ja/LC_MESSAGES/sphinx.po3711
-rw-r--r--sphinx/locale/ka/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ka/LC_MESSAGES/sphinx.mobin0 -> 74059 bytes
-rw-r--r--sphinx/locale/ka/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/ko/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ko/LC_MESSAGES/sphinx.mobin0 -> 82285 bytes
-rw-r--r--sphinx/locale/ko/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/lt/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/lt/LC_MESSAGES/sphinx.mobin0 -> 6832 bytes
-rw-r--r--sphinx/locale/lt/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/lv/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/lv/LC_MESSAGES/sphinx.mobin0 -> 6501 bytes
-rw-r--r--sphinx/locale/lv/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/mk/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/mk/LC_MESSAGES/sphinx.mobin0 -> 2011 bytes
-rw-r--r--sphinx/locale/mk/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/nb_NO/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/nb_NO/LC_MESSAGES/sphinx.mobin0 -> 6500 bytes
-rw-r--r--sphinx/locale/nb_NO/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/ne/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ne/LC_MESSAGES/sphinx.mobin0 -> 8520 bytes
-rw-r--r--sphinx/locale/ne/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/nl/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/nl/LC_MESSAGES/sphinx.mobin0 -> 18611 bytes
-rw-r--r--sphinx/locale/nl/LC_MESSAGES/sphinx.po3701
-rw-r--r--sphinx/locale/pl/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/pl/LC_MESSAGES/sphinx.mobin0 -> 28827 bytes
-rw-r--r--sphinx/locale/pl/LC_MESSAGES/sphinx.po3700
-rw-r--r--sphinx/locale/pt/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/pt/LC_MESSAGES/sphinx.mobin0 -> 544 bytes
-rw-r--r--sphinx/locale/pt/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/pt_BR/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/pt_BR/LC_MESSAGES/sphinx.mobin0 -> 81014 bytes
-rw-r--r--sphinx/locale/pt_BR/LC_MESSAGES/sphinx.po3700
-rw-r--r--sphinx/locale/pt_PT/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/pt_PT/LC_MESSAGES/sphinx.mobin0 -> 7764 bytes
-rw-r--r--sphinx/locale/pt_PT/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/ro/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ro/LC_MESSAGES/sphinx.mobin0 -> 8259 bytes
-rw-r--r--sphinx/locale/ro/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/ru/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ru/LC_MESSAGES/sphinx.mobin0 -> 15343 bytes
-rw-r--r--sphinx/locale/ru/LC_MESSAGES/sphinx.po3701
-rw-r--r--sphinx/locale/si/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/si/LC_MESSAGES/sphinx.mobin0 -> 3560 bytes
-rw-r--r--sphinx/locale/si/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/sk/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sk/LC_MESSAGES/sphinx.mobin0 -> 66206 bytes
-rw-r--r--sphinx/locale/sk/LC_MESSAGES/sphinx.po3697
-rw-r--r--sphinx/locale/sl/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sl/LC_MESSAGES/sphinx.mobin0 -> 5157 bytes
-rw-r--r--sphinx/locale/sl/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/sphinx.pot3714
-rw-r--r--sphinx/locale/sq/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sq/LC_MESSAGES/sphinx.mobin0 -> 79459 bytes
-rw-r--r--sphinx/locale/sq/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/sr/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sr/LC_MESSAGES/sphinx.mobin0 -> 9193 bytes
-rw-r--r--sphinx/locale/sr/LC_MESSAGES/sphinx.po3696
-rw-r--r--sphinx/locale/sr@latin/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sr@latin/LC_MESSAGES/sphinx.mobin0 -> 584 bytes
-rw-r--r--sphinx/locale/sr@latin/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/sr_RS/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sr_RS/LC_MESSAGES/sphinx.mobin0 -> 579 bytes
-rw-r--r--sphinx/locale/sr_RS/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/sv/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/sv/LC_MESSAGES/sphinx.mobin0 -> 6491 bytes
-rw-r--r--sphinx/locale/sv/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/ta/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ta/LC_MESSAGES/sphinx.mobin0 -> 647 bytes
-rw-r--r--sphinx/locale/ta/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/te/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/te/LC_MESSAGES/sphinx.mobin0 -> 489 bytes
-rw-r--r--sphinx/locale/te/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/tr/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/tr/LC_MESSAGES/sphinx.mobin0 -> 56773 bytes
-rw-r--r--sphinx/locale/tr/LC_MESSAGES/sphinx.po3698
-rw-r--r--sphinx/locale/uk_UA/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/uk_UA/LC_MESSAGES/sphinx.mobin0 -> 6349 bytes
-rw-r--r--sphinx/locale/uk_UA/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/ur/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/ur/LC_MESSAGES/sphinx.mobin0 -> 487 bytes
-rw-r--r--sphinx/locale/ur/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/vi/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/vi/LC_MESSAGES/sphinx.mobin0 -> 5771 bytes
-rw-r--r--sphinx/locale/vi/LC_MESSAGES/sphinx.po3695
-rw-r--r--sphinx/locale/yue/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/yue/LC_MESSAGES/sphinx.mobin0 -> 487 bytes
-rw-r--r--sphinx/locale/yue/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/zh_CN/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/zh_CN/LC_MESSAGES/sphinx.mobin0 -> 75427 bytes
-rw-r--r--sphinx/locale/zh_CN/LC_MESSAGES/sphinx.po3712
-rw-r--r--sphinx/locale/zh_HK/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/zh_HK/LC_MESSAGES/sphinx.mobin0 -> 501 bytes
-rw-r--r--sphinx/locale/zh_HK/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.mobin0 -> 516 bytes
-rw-r--r--sphinx/locale/zh_TW.Big5/LC_MESSAGES/sphinx.po3694
-rw-r--r--sphinx/locale/zh_TW/LC_MESSAGES/sphinx.js60
-rw-r--r--sphinx/locale/zh_TW/LC_MESSAGES/sphinx.mobin0 -> 74037 bytes
-rw-r--r--sphinx/locale/zh_TW/LC_MESSAGES/sphinx.po3702
-rw-r--r--sphinx/parsers.py97
-rw-r--r--sphinx/project.py112
-rw-r--r--sphinx/py.typed0
-rw-r--r--sphinx/pycode/__init__.py152
-rw-r--r--sphinx/pycode/ast.py188
-rw-r--r--sphinx/pycode/parser.py577
-rw-r--r--sphinx/pygments_styles.py96
-rw-r--r--sphinx/registry.py517
-rw-r--r--sphinx/roles.py433
-rw-r--r--sphinx/search/__init__.py556
-rw-r--r--sphinx/search/da.py120
-rw-r--r--sphinx/search/de.py303
-rw-r--r--sphinx/search/en.py220
-rw-r--r--sphinx/search/es.py363
-rw-r--r--sphinx/search/fi.py113
-rw-r--r--sphinx/search/fr.py199
-rw-r--r--sphinx/search/hu.py226
-rw-r--r--sphinx/search/it.py316
-rw-r--r--sphinx/search/ja.py531
-rw-r--r--sphinx/search/minified-js/base-stemmer.js1
-rw-r--r--sphinx/search/minified-js/danish-stemmer.js1
-rw-r--r--sphinx/search/minified-js/dutch-stemmer.js1
-rw-r--r--sphinx/search/minified-js/finnish-stemmer.js1
-rw-r--r--sphinx/search/minified-js/french-stemmer.js1
-rw-r--r--sphinx/search/minified-js/german-stemmer.js1
-rw-r--r--sphinx/search/minified-js/hungarian-stemmer.js1
-rw-r--r--sphinx/search/minified-js/italian-stemmer.js1
-rw-r--r--sphinx/search/minified-js/norwegian-stemmer.js1
-rw-r--r--sphinx/search/minified-js/porter-stemmer.js1
-rw-r--r--sphinx/search/minified-js/portuguese-stemmer.js1
-rw-r--r--sphinx/search/minified-js/romanian-stemmer.js1
-rw-r--r--sphinx/search/minified-js/russian-stemmer.js1
-rw-r--r--sphinx/search/minified-js/spanish-stemmer.js1
-rw-r--r--sphinx/search/minified-js/swedish-stemmer.js1
-rw-r--r--sphinx/search/minified-js/turkish-stemmer.js1
-rw-r--r--sphinx/search/nl.py127
-rw-r--r--sphinx/search/no.py202
-rw-r--r--sphinx/search/non-minified-js/base-stemmer.js294
-rw-r--r--sphinx/search/non-minified-js/danish-stemmer.js310
-rw-r--r--sphinx/search/non-minified-js/dutch-stemmer.js685
-rw-r--r--sphinx/search/non-minified-js/finnish-stemmer.js790
-rw-r--r--sphinx/search/non-minified-js/french-stemmer.js1325
-rw-r--r--sphinx/search/non-minified-js/german-stemmer.js577
-rw-r--r--sphinx/search/non-minified-js/hungarian-stemmer.js711
-rw-r--r--sphinx/search/non-minified-js/italian-stemmer.js996
-rw-r--r--sphinx/search/non-minified-js/norwegian-stemmer.js261
-rw-r--r--sphinx/search/non-minified-js/porter-stemmer.js749
-rw-r--r--sphinx/search/non-minified-js/portuguese-stemmer.js914
-rw-r--r--sphinx/search/non-minified-js/romanian-stemmer.js872
-rw-r--r--sphinx/search/non-minified-js/russian-stemmer.js624
-rw-r--r--sphinx/search/non-minified-js/spanish-stemmer.js990
-rw-r--r--sphinx/search/non-minified-js/swedish-stemmer.js265
-rw-r--r--sphinx/search/non-minified-js/turkish-stemmer.js2439
-rw-r--r--sphinx/search/pt.py261
-rw-r--r--sphinx/search/ro.py22
-rw-r--r--sphinx/search/ru.py251
-rw-r--r--sphinx/search/sv.py140
-rw-r--r--sphinx/search/tr.py22
-rw-r--r--sphinx/search/zh.py262
-rw-r--r--sphinx/templates/apidoc/module.rst_t9
-rw-r--r--sphinx/templates/apidoc/package.rst_t57
-rw-r--r--sphinx/templates/apidoc/toc.rst_t8
-rw-r--r--sphinx/templates/epub3/container.xml6
-rw-r--r--sphinx/templates/epub3/content.opf_t50
-rw-r--r--sphinx/templates/epub3/mimetype1
-rw-r--r--sphinx/templates/epub3/nav.xhtml_t26
-rw-r--r--sphinx/templates/epub3/toc.ncx_t24
-rw-r--r--sphinx/templates/gettext/message.pot_t33
-rw-r--r--sphinx/templates/graphviz/graphviz.css19
-rw-r--r--sphinx/templates/htmlhelp/project.hhc31
-rw-r--r--sphinx/templates/htmlhelp/project.hhp21
-rw-r--r--sphinx/templates/htmlhelp/project.stp33
-rw-r--r--sphinx/templates/imgmath/preview.tex_t18
-rw-r--r--sphinx/templates/imgmath/template.tex_t14
-rw-r--r--sphinx/templates/latex/latex.tex_t108
-rw-r--r--sphinx/templates/latex/longtable.tex_t74
-rw-r--r--sphinx/templates/latex/sphinxmessages.sty_t21
-rw-r--r--sphinx/templates/latex/tabular.tex_t54
-rw-r--r--sphinx/templates/latex/tabulary.tex_t54
-rw-r--r--sphinx/templates/quickstart/Makefile.new_t21
-rw-r--r--sphinx/templates/quickstart/Makefile_t98
-rw-r--r--sphinx/templates/quickstart/conf.py_t71
-rw-r--r--sphinx/templates/quickstart/make.bat.new_t36
-rw-r--r--sphinx/templates/quickstart/make.bat_t110
-rw-r--r--sphinx/templates/quickstart/root_doc.rst_t21
-rw-r--r--sphinx/templates/texinfo/Makefile57
-rw-r--r--sphinx/testing/__init__.py7
-rw-r--r--sphinx/testing/fixtures.py243
-rw-r--r--sphinx/testing/path.py221
-rw-r--r--sphinx/testing/restructuredtext.py35
-rw-r--r--sphinx/testing/util.py171
-rw-r--r--sphinx/texinputs/LICRcyr2utf8.xdy101
-rw-r--r--sphinx/texinputs/LICRlatin2utf8.xdy239
-rw-r--r--sphinx/texinputs/LatinRules.xdy611
-rw-r--r--sphinx/texinputs/Makefile_t92
-rw-r--r--sphinx/texinputs/latexmkjarc_t22
-rw-r--r--sphinx/texinputs/latexmkrc_t32
-rw-r--r--sphinx/texinputs/make.bat_t50
-rw-r--r--sphinx/texinputs/python.ist16
-rw-r--r--sphinx/texinputs/sphinx.sty1013
-rw-r--r--sphinx/texinputs/sphinx.xdy230
-rw-r--r--sphinx/texinputs/sphinxhowto.cls102
-rw-r--r--sphinx/texinputs/sphinxlatexadmonitions.sty242
-rw-r--r--sphinx/texinputs/sphinxlatexcontainers.sty22
-rw-r--r--sphinx/texinputs/sphinxlatexgraphics.sty122
-rw-r--r--sphinx/texinputs/sphinxlatexindbibtoc.sty69
-rw-r--r--sphinx/texinputs/sphinxlatexlists.sty131
-rw-r--r--sphinx/texinputs/sphinxlatexliterals.sty1004
-rw-r--r--sphinx/texinputs/sphinxlatexnumfig.sty122
-rw-r--r--sphinx/texinputs/sphinxlatexobjects.sty365
-rw-r--r--sphinx/texinputs/sphinxlatexshadowbox.sty116
-rw-r--r--sphinx/texinputs/sphinxlatexstyleheadings.sty86
-rw-r--r--sphinx/texinputs/sphinxlatexstylepage.sty79
-rw-r--r--sphinx/texinputs/sphinxlatexstyletext.sty181
-rw-r--r--sphinx/texinputs/sphinxlatextables.sty1246
-rw-r--r--sphinx/texinputs/sphinxmanual.cls128
-rw-r--r--sphinx/texinputs/sphinxoptionsgeometry.sty54
-rw-r--r--sphinx/texinputs/sphinxoptionshyperref.sty35
-rw-r--r--sphinx/texinputs/sphinxpackageboxes.sty854
-rw-r--r--sphinx/texinputs/sphinxpackagecyrillic.sty55
-rw-r--r--sphinx/texinputs/sphinxpackagefootnote.sty433
-rw-r--r--sphinx/texinputs_win/Makefile_t86
-rw-r--r--sphinx/themes/agogo/layout.html104
-rw-r--r--sphinx/themes/agogo/static/agogo.css_t563
-rw-r--r--sphinx/themes/agogo/static/bgfooter.pngbin0 -> 276 bytes
-rw-r--r--sphinx/themes/agogo/static/bgtop.pngbin0 -> 266 bytes
-rw-r--r--sphinx/themes/agogo/theme.conf20
-rw-r--r--sphinx/themes/basic/changes/frameset.html11
-rw-r--r--sphinx/themes/basic/changes/rstsource.html15
-rw-r--r--sphinx/themes/basic/changes/versionchanges.html33
-rw-r--r--sphinx/themes/basic/defindex.html35
-rw-r--r--sphinx/themes/basic/domainindex.html56
-rw-r--r--sphinx/themes/basic/genindex-single.html63
-rw-r--r--sphinx/themes/basic/genindex-split.html41
-rw-r--r--sphinx/themes/basic/genindex.html76
-rw-r--r--sphinx/themes/basic/globaltoc.html11
-rw-r--r--sphinx/themes/basic/layout.html220
-rw-r--r--sphinx/themes/basic/localtoc.html15
-rw-r--r--sphinx/themes/basic/opensearch.xml13
-rw-r--r--sphinx/themes/basic/page.html13
-rw-r--r--sphinx/themes/basic/relations.html23
-rw-r--r--sphinx/themes/basic/search.html65
-rw-r--r--sphinx/themes/basic/searchbox.html21
-rw-r--r--sphinx/themes/basic/searchfield.html23
-rw-r--r--sphinx/themes/basic/sourcelink.html18
-rw-r--r--sphinx/themes/basic/static/basic.css_t925
-rw-r--r--sphinx/themes/basic/static/doctools.js156
-rw-r--r--sphinx/themes/basic/static/documentation_options.js_t13
-rw-r--r--sphinx/themes/basic/static/file.pngbin0 -> 286 bytes
-rw-r--r--sphinx/themes/basic/static/language_data.js_t26
-rw-r--r--sphinx/themes/basic/static/minus.pngbin0 -> 90 bytes
-rw-r--r--sphinx/themes/basic/static/plus.pngbin0 -> 90 bytes
-rw-r--r--sphinx/themes/basic/static/searchtools.js574
-rw-r--r--sphinx/themes/basic/static/sphinx_highlight.js154
-rw-r--r--sphinx/themes/basic/theme.conf16
-rw-r--r--sphinx/themes/bizstyle/layout.html27
-rw-r--r--sphinx/themes/bizstyle/static/background_b01.pngbin0 -> 78 bytes
-rw-r--r--sphinx/themes/bizstyle/static/bizstyle.css_t523
-rw-r--r--sphinx/themes/bizstyle/static/bizstyle.js_t30
-rw-r--r--sphinx/themes/bizstyle/static/css3-mediaqueries.js1
-rw-r--r--sphinx/themes/bizstyle/static/css3-mediaqueries_src.js1104
-rw-r--r--sphinx/themes/bizstyle/theme.conf10
-rw-r--r--sphinx/themes/classic/layout.html23
-rw-r--r--sphinx/themes/classic/static/classic.css_t353
-rw-r--r--sphinx/themes/classic/static/sidebar.js_t72
-rw-r--r--sphinx/themes/classic/theme.conf32
-rw-r--r--sphinx/themes/default/static/default.css1
-rw-r--r--sphinx/themes/default/theme.conf2
-rw-r--r--sphinx/themes/epub/epub-cover.html25
-rw-r--r--sphinx/themes/epub/layout.html21
-rw-r--r--sphinx/themes/epub/static/epub.css_t734
-rw-r--r--sphinx/themes/epub/theme.conf8
-rw-r--r--sphinx/themes/haiku/layout.html66
-rw-r--r--sphinx/themes/haiku/static/alert_info_32.pngbin0 -> 1128 bytes
-rw-r--r--sphinx/themes/haiku/static/alert_warning_32.pngbin0 -> 944 bytes
-rw-r--r--sphinx/themes/haiku/static/bg-page.pngbin0 -> 82 bytes
-rw-r--r--sphinx/themes/haiku/static/bullet_orange.pngbin0 -> 165 bytes
-rw-r--r--sphinx/themes/haiku/static/haiku.css_t375
-rw-r--r--sphinx/themes/haiku/theme.conf14
-rw-r--r--sphinx/themes/nature/static/nature.css_t252
-rw-r--r--sphinx/themes/nature/theme.conf4
-rw-r--r--sphinx/themes/nonav/layout.html23
-rw-r--r--sphinx/themes/nonav/static/nonav.css_t589
-rw-r--r--sphinx/themes/nonav/theme.conf8
-rw-r--r--sphinx/themes/pyramid/layout.html24
-rw-r--r--sphinx/themes/pyramid/static/dialog-note.pngbin0 -> 1394 bytes
-rw-r--r--sphinx/themes/pyramid/static/dialog-seealso.pngbin0 -> 1351 bytes
-rw-r--r--sphinx/themes/pyramid/static/dialog-todo.pngbin0 -> 1186 bytes
-rw-r--r--sphinx/themes/pyramid/static/dialog-topic.pngbin0 -> 1798 bytes
-rw-r--r--sphinx/themes/pyramid/static/dialog-warning.pngbin0 -> 1280 bytes
-rw-r--r--sphinx/themes/pyramid/static/epub.css_t312
-rw-r--r--sphinx/themes/pyramid/static/footerbg.pngbin0 -> 333 bytes
-rw-r--r--sphinx/themes/pyramid/static/headerbg.pngbin0 -> 190 bytes
-rw-r--r--sphinx/themes/pyramid/static/ie6.css7
-rw-r--r--sphinx/themes/pyramid/static/middlebg.pngbin0 -> 101 bytes
-rw-r--r--sphinx/themes/pyramid/static/pyramid.css_t348
-rw-r--r--sphinx/themes/pyramid/static/transparent.gifbin0 -> 49 bytes
-rw-r--r--sphinx/themes/pyramid/theme.conf4
-rw-r--r--sphinx/themes/scrolls/artwork/logo.svg107
-rw-r--r--sphinx/themes/scrolls/layout.html50
-rw-r--r--sphinx/themes/scrolls/static/darkmetal.pngbin0 -> 25238 bytes
-rw-r--r--sphinx/themes/scrolls/static/headerbg.pngbin0 -> 172 bytes
-rw-r--r--sphinx/themes/scrolls/static/logo.pngbin0 -> 8305 bytes
-rw-r--r--sphinx/themes/scrolls/static/metal.pngbin0 -> 7547 bytes
-rw-r--r--sphinx/themes/scrolls/static/navigation.pngbin0 -> 124 bytes
-rw-r--r--sphinx/themes/scrolls/static/print.css7
-rw-r--r--sphinx/themes/scrolls/static/scrolls.css_t502
-rw-r--r--sphinx/themes/scrolls/static/theme_extras.js12
-rw-r--r--sphinx/themes/scrolls/static/watermark.pngbin0 -> 44483 bytes
-rw-r--r--sphinx/themes/scrolls/static/watermark_blur.pngbin0 -> 8049 bytes
-rw-r--r--sphinx/themes/scrolls/theme.conf13
-rw-r--r--sphinx/themes/sphinxdoc/static/contents.pngbin0 -> 107 bytes
-rw-r--r--sphinx/themes/sphinxdoc/static/navigation.pngbin0 -> 120 bytes
-rw-r--r--sphinx/themes/sphinxdoc/static/sphinxdoc.css_t354
-rw-r--r--sphinx/themes/sphinxdoc/theme.conf4
-rw-r--r--sphinx/themes/traditional/static/traditional.css_t765
-rw-r--r--sphinx/themes/traditional/theme.conf7
-rw-r--r--sphinx/theming.py232
-rw-r--r--sphinx/transforms/__init__.py516
-rw-r--r--sphinx/transforms/compact_bullet_list.py91
-rw-r--r--sphinx/transforms/i18n.py624
-rw-r--r--sphinx/transforms/post_transforms/__init__.py297
-rw-r--r--sphinx/transforms/post_transforms/code.py139
-rw-r--r--sphinx/transforms/post_transforms/images.py280
-rw-r--r--sphinx/transforms/references.py47
-rw-r--r--sphinx/util/__init__.py297
-rw-r--r--sphinx/util/_pathlib.py115
-rw-r--r--sphinx/util/build_phase.py12
-rw-r--r--sphinx/util/cfamily.py464
-rw-r--r--sphinx/util/console.py129
-rw-r--r--sphinx/util/display.py94
-rw-r--r--sphinx/util/docfields.py408
-rw-r--r--sphinx/util/docstrings.py88
-rw-r--r--sphinx/util/docutils.py635
-rw-r--r--sphinx/util/exceptions.py67
-rw-r--r--sphinx/util/fileutil.py100
-rw-r--r--sphinx/util/http_date.py39
-rw-r--r--sphinx/util/i18n.py253
-rw-r--r--sphinx/util/images.py146
-rw-r--r--sphinx/util/index_entries.py27
-rw-r--r--sphinx/util/inspect.py833
-rw-r--r--sphinx/util/inventory.py172
-rw-r--r--sphinx/util/logging.py602
-rw-r--r--sphinx/util/matching.py169
-rw-r--r--sphinx/util/math.py61
-rw-r--r--sphinx/util/nodes.py672
-rw-r--r--sphinx/util/osutil.py217
-rw-r--r--sphinx/util/parallel.py154
-rw-r--r--sphinx/util/png.py43
-rw-r--r--sphinx/util/requests.py73
-rw-r--r--sphinx/util/rst.py110
-rw-r--r--sphinx/util/tags.py88
-rw-r--r--sphinx/util/template.py135
-rw-r--r--sphinx/util/texescape.py153
-rw-r--r--sphinx/util/typing.py402
-rw-r--r--sphinx/versioning.py178
-rw-r--r--sphinx/writers/__init__.py1
-rw-r--r--sphinx/writers/html.py44
-rw-r--r--sphinx/writers/html5.py936
-rw-r--r--sphinx/writers/latex.py2266
-rw-r--r--sphinx/writers/manpage.py473
-rw-r--r--sphinx/writers/texinfo.py1572
-rw-r--r--sphinx/writers/text.py1305
-rw-r--r--sphinx/writers/xml.py52
-rw-r--r--tests/__init__.py0
-rw-r--r--tests/certs/cert.pem50
-rw-r--r--tests/conftest.py40
-rw-r--r--tests/ext_napoleon_pep526_data_google.py16
-rw-r--r--tests/ext_napoleon_pep526_data_numpy.py20
-rw-r--r--tests/js/documentation_options.js1
-rw-r--r--tests/js/searchtools.js62
-rw-r--r--tests/js/sphinx_highlight.js39
-rw-r--r--tests/roots/test-add_enumerable_node/conf.py7
-rw-r--r--tests/roots/test-add_enumerable_node/enumerable_node.py62
-rw-r--r--tests/roots/test-add_enumerable_node/index.rst48
-rw-r--r--tests/roots/test-add_enumerable_node/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-add_source_parser-conflicts-with-users-setting/conf.py17
-rw-r--r--tests/roots/test-add_source_parser-conflicts-with-users-setting/source_parser.py10
-rw-r--r--tests/roots/test-add_source_parser/conf.py8
-rw-r--r--tests/roots/test-add_source_parser/source_parser.py10
-rw-r--r--tests/roots/test-api-set-translator/conf.py72
-rw-r--r--tests/roots/test-api-set-translator/index.rst3
-rw-r--r--tests/roots/test-api-set-translator/nonext/conf.py6
-rw-r--r--tests/roots/test-api-set-translator/translator.py5
-rw-r--r--tests/roots/test-apidoc-duplicates/fish_licence/halibut.cpython-38-x86_64-linux-gnu.so0
-rw-r--r--tests/roots/test-apidoc-duplicates/fish_licence/halibut.pyx0
-rw-r--r--tests/roots/test-apidoc-pep420/a/b/c/__init__.py1
-rw-r--r--tests/roots/test-apidoc-pep420/a/b/c/d.py1
-rw-r--r--tests/roots/test-apidoc-pep420/a/b/e/__init__.py0
-rw-r--r--tests/roots/test-apidoc-pep420/a/b/e/f.py1
-rw-r--r--tests/roots/test-apidoc-pep420/a/b/x/y.py1
-rw-r--r--tests/roots/test-apidoc-subpackage-in-toc/parent/__init__.py0
-rw-r--r--tests/roots/test-apidoc-subpackage-in-toc/parent/child/__init__.py0
-rw-r--r--tests/roots/test-apidoc-subpackage-in-toc/parent/child/foo.py1
-rw-r--r--tests/roots/test-apidoc-toc/mypackage/__init__.py0
-rwxr-xr-xtests/roots/test-apidoc-toc/mypackage/main.py15
-rw-r--r--tests/roots/test-apidoc-toc/mypackage/no_init/foo.py1
-rw-r--r--tests/roots/test-apidoc-toc/mypackage/resource/__init__.py0
-rw-r--r--tests/roots/test-apidoc-toc/mypackage/resource/resource.txt1
-rw-r--r--tests/roots/test-apidoc-toc/mypackage/something/__init__.py1
-rw-r--r--tests/roots/test-apidoc-trailing-underscore/package_/__init__.py1
-rw-r--r--tests/roots/test-apidoc-trailing-underscore/package_/module_.py9
-rw-r--r--tests/roots/test-autosummary/conf.py12
-rw-r--r--tests/roots/test-autosummary/dummy_module.py85
-rw-r--r--tests/roots/test-autosummary/index.rst8
-rw-r--r--tests/roots/test-autosummary/sphinx.rst31
-rw-r--r--tests/roots/test-autosummary/underscore_module_.py15
-rw-r--r--tests/roots/test-basic/conf.py3
-rw-r--r--tests/roots/test-basic/index.rst31
-rw-r--r--tests/roots/test-build-html-theme-having-multiple-stylesheets/_themes/mytheme/_static/extra.css0
-rw-r--r--tests/roots/test-build-html-theme-having-multiple-stylesheets/_themes/mytheme/_static/mytheme.css0
-rw-r--r--tests/roots/test-build-html-theme-having-multiple-stylesheets/_themes/mytheme/theme.conf3
-rw-r--r--tests/roots/test-build-html-theme-having-multiple-stylesheets/conf.py2
-rw-r--r--tests/roots/test-build-html-theme-having-multiple-stylesheets/index.rst2
-rw-r--r--tests/roots/test-build-html-translator/conf.py16
-rw-r--r--tests/roots/test-build-html-translator/index.rst24
-rw-r--r--tests/roots/test-build-text/conf.py2
-rw-r--r--tests/roots/test-build-text/doc1.txt2
-rw-r--r--tests/roots/test-build-text/doc2.txt9
-rw-r--r--tests/roots/test-build-text/index.txt11
-rw-r--r--tests/roots/test-build-text/lineblock.txt6
-rw-r--r--tests/roots/test-build-text/listitems.txt4
-rw-r--r--tests/roots/test-build-text/maxwidth.txt6
-rw-r--r--tests/roots/test-build-text/nonascii_maxwidth.txt5
-rw-r--r--tests/roots/test-build-text/nonascii_table.txt7
-rw-r--r--tests/roots/test-build-text/nonascii_title.txt2
-rw-r--r--tests/roots/test-build-text/table.txt7
-rw-r--r--tests/roots/test-build-text/table_colspan.txt7
-rw-r--r--tests/roots/test-build-text/table_colspan_and_rowspan.txt7
-rw-r--r--tests/roots/test-build-text/table_colspan_left.txt7
-rw-r--r--tests/roots/test-build-text/table_rowspan.txt7
-rw-r--r--tests/roots/test-builder-dirhtml/bar.rst4
-rw-r--r--tests/roots/test-builder-dirhtml/conf.py0
-rw-r--r--tests/roots/test-builder-dirhtml/foo/foo_1.rst4
-rw-r--r--tests/roots/test-builder-dirhtml/foo/foo_2.rst4
-rw-r--r--tests/roots/test-builder-dirhtml/foo/index.rst9
-rw-r--r--tests/roots/test-builder-dirhtml/index.rst9
-rw-r--r--tests/roots/test-builder-gettext-dont-rebuild-mo/bom.rst5
-rw-r--r--tests/roots/test-builder-gettext-dont-rebuild-mo/conf.py1
-rw-r--r--tests/roots/test-builder-gettext-dont-rebuild-mo/index.rst6
-rw-r--r--tests/roots/test-builder-gettext-dont-rebuild-mo/xx/LC_MESSAGES/bom.po12
-rw-r--r--tests/roots/test-changes/base.rst20
-rw-r--r--tests/roots/test-changes/c-api.rst24
-rw-r--r--tests/roots/test-changes/conf.py4
-rw-r--r--tests/roots/test-changes/contents.rst13
-rw-r--r--tests/roots/test-changes/library/utils.rst25
-rw-r--r--tests/roots/test-circular/conf.py1
-rw-r--r--tests/roots/test-circular/index.rst4
-rw-r--r--tests/roots/test-circular/sub.rst3
-rw-r--r--tests/roots/test-config/conf.py3
-rw-r--r--tests/roots/test-copyright-multiline/conf.py9
-rw-r--r--tests/roots/test-copyright-multiline/index.rst3
-rw-r--r--tests/roots/test-correct-year/conf.py1
-rw-r--r--tests/roots/test-correct-year/index.rst4
-rw-r--r--tests/roots/test-default_role/conf.py0
-rw-r--r--tests/roots/test-default_role/foo.rst4
-rw-r--r--tests/roots/test-default_role/index.rst6
-rw-r--r--tests/roots/test-directive-code/caption.rst52
-rw-r--r--tests/roots/test-directive-code/classes.rst21
-rw-r--r--tests/roots/test-directive-code/conf.py2
-rw-r--r--tests/roots/test-directive-code/dedent.rst64
-rw-r--r--tests/roots/test-directive-code/emphasize.rst7
-rw-r--r--tests/roots/test-directive-code/empty.inc3
-rw-r--r--tests/roots/test-directive-code/error.inc1
-rw-r--r--tests/roots/test-directive-code/force.rst16
-rw-r--r--tests/roots/test-directive-code/highlight.rst20
-rw-r--r--tests/roots/test-directive-code/index.rst25
-rw-r--r--tests/roots/test-directive-code/linenos.rst18
-rw-r--r--tests/roots/test-directive-code/linenothreshold.rst23
-rw-r--r--tests/roots/test-directive-code/literal-diff.inc13
-rw-r--r--tests/roots/test-directive-code/literal-short.inc3
-rw-r--r--tests/roots/test-directive-code/literal.inc13
-rw-r--r--tests/roots/test-directive-code/namedblocks.rst28
-rw-r--r--tests/roots/test-directive-code/py-decorators.inc15
-rw-r--r--tests/roots/test-directive-code/py-decorators.rst17
-rw-r--r--tests/roots/test-directive-code/python.rst13
-rw-r--r--tests/roots/test-directive-code/target.py26
-rw-r--r--tests/roots/test-directive-csv-table/conf.py0
-rw-r--r--tests/roots/test-directive-csv-table/example.csv1
-rw-r--r--tests/roots/test-directive-csv-table/subdir/example.csv1
-rw-r--r--tests/roots/test-directive-include/bar.txt1
-rw-r--r--tests/roots/test-directive-include/baz/baz.rst6
-rw-r--r--tests/roots/test-directive-include/conf.py2
-rw-r--r--tests/roots/test-directive-include/foo.rst1
-rw-r--r--tests/roots/test-directive-include/text.txt1
-rw-r--r--tests/roots/test-directive-only/conf.py2
-rw-r--r--tests/roots/test-directive-only/index.rst6
-rw-r--r--tests/roots/test-directive-only/only.rst203
-rw-r--r--tests/roots/test-directives-raw/conf.py0
-rw-r--r--tests/roots/test-directives-raw/index.rst40
-rw-r--r--tests/roots/test-docutilsconf/conf.py0
-rw-r--r--tests/roots/test-docutilsconf/docutils.conf0
-rw-r--r--tests/roots/test-docutilsconf/index.rst6
-rw-r--r--tests/roots/test-domain-c-c_maximum_signature_line_length/conf.py1
-rw-r--r--tests/roots/test-domain-c-c_maximum_signature_line_length/index.rst4
-rw-r--r--tests/roots/test-domain-c-intersphinx/conf.py4
-rw-r--r--tests/roots/test-domain-c-intersphinx/index.rst62
-rw-r--r--tests/roots/test-domain-c/anon-dup-decl.rst7
-rw-r--r--tests/roots/test-domain-c/conf.py1
-rw-r--r--tests/roots/test-domain-c/field-role.rst4
-rw-r--r--tests/roots/test-domain-c/function_param_target.rst7
-rw-r--r--tests/roots/test-domain-c/index.rst54
-rw-r--r--tests/roots/test-domain-c/namespace.rst21
-rw-r--r--tests/roots/test-domain-c/ns_lookup.rst13
-rw-r--r--tests/roots/test-domain-cpp-cpp_maximum_signature_line_length/conf.py1
-rw-r--r--tests/roots/test-domain-cpp-cpp_maximum_signature_line_length/index.rst4
-rw-r--r--tests/roots/test-domain-cpp-intersphinx/conf.py4
-rw-r--r--tests/roots/test-domain-cpp-intersphinx/index.rst112
-rw-r--r--tests/roots/test-domain-cpp/anon-dup-decl.rst4
-rw-r--r--tests/roots/test-domain-cpp/any-role.rst17
-rw-r--r--tests/roots/test-domain-cpp/backslash.rst1
-rw-r--r--tests/roots/test-domain-cpp/conf.py1
-rw-r--r--tests/roots/test-domain-cpp/field-role.rst5
-rw-r--r--tests/roots/test-domain-cpp/index.rst53
-rw-r--r--tests/roots/test-domain-cpp/lookup-key-overload.rst8
-rw-r--r--tests/roots/test-domain-cpp/multi-decl-lookup.rst24
-rw-r--r--tests/roots/test-domain-cpp/roles-targets-ok.rst170
-rw-r--r--tests/roots/test-domain-cpp/roles-targets-warn.rst158
-rw-r--r--tests/roots/test-domain-cpp/roles.rst17
-rw-r--r--tests/roots/test-domain-cpp/roles2.rst5
-rw-r--r--tests/roots/test-domain-cpp/semicolon.rst14
-rw-r--r--tests/roots/test-domain-cpp/warn-template-param-qualified-name.rst11
-rw-r--r--tests/roots/test-domain-cpp/xref_consistency.rst12
-rw-r--r--tests/roots/test-domain-js-javascript_maximum_signature_line_length/conf.py1
-rw-r--r--tests/roots/test-domain-js-javascript_maximum_signature_line_length/index.rst6
-rw-r--r--tests/roots/test-domain-js/conf.py1
-rw-r--r--tests/roots/test-domain-js/index.rst7
-rw-r--r--tests/roots/test-domain-js/module.rst27
-rw-r--r--tests/roots/test-domain-js/roles.rst48
-rw-r--r--tests/roots/test-domain-py-python_maximum_signature_line_length/conf.py1
-rw-r--r--tests/roots/test-domain-py-python_maximum_signature_line_length/index.rst6
-rw-r--r--tests/roots/test-domain-py-python_use_unqualified_type_names/conf.py1
-rw-r--r--tests/roots/test-domain-py-python_use_unqualified_type_names/index.rst12
-rw-r--r--tests/roots/test-domain-py-xref-warning/conf.py0
-rw-r--r--tests/roots/test-domain-py-xref-warning/index.rst7
-rw-r--r--tests/roots/test-domain-py/abbr.rst10
-rw-r--r--tests/roots/test-domain-py/canonical.rst12
-rw-r--r--tests/roots/test-domain-py/conf.py1
-rw-r--r--tests/roots/test-domain-py/index.rst10
-rw-r--r--tests/roots/test-domain-py/module.rst60
-rw-r--r--tests/roots/test-domain-py/module_option.rst25
-rw-r--r--tests/roots/test-domain-py/roles.rst48
-rw-r--r--tests/roots/test-double-inheriting-theme/base_themes_dir/base_theme1/theme.conf2
-rw-r--r--tests/roots/test-double-inheriting-theme/base_themes_dir/base_theme2/theme.conf2
-rw-r--r--tests/roots/test-double-inheriting-theme/conf.py4
-rw-r--r--tests/roots/test-double-inheriting-theme/index.rst3
-rw-r--r--tests/roots/test-environment-record-dependencies/api.rst4
-rw-r--r--tests/roots/test-environment-record-dependencies/conf.py5
-rw-r--r--tests/roots/test-environment-record-dependencies/example_module.py2
-rw-r--r--tests/roots/test-environment-record-dependencies/index.rst3
-rw-r--r--tests/roots/test-epub-anchor-id/conf.py2
-rw-r--r--tests/roots/test-epub-anchor-id/index.rst13
-rw-r--r--tests/roots/test-ext-autodoc/autodoc_dummy_bar.py6
-rw-r--r--tests/roots/test-ext-autodoc/autodoc_dummy_module.py6
-rw-r--r--tests/roots/test-ext-autodoc/bug2437/__init__.py0
-rw-r--r--tests/roots/test-ext-autodoc/bug2437/autodoc_dummy_foo.py3
-rw-r--r--tests/roots/test-ext-autodoc/circular_import/__init__.py1
-rw-r--r--tests/roots/test-ext-autodoc/circular_import/a.py1
-rw-r--r--tests/roots/test-ext-autodoc/circular_import/b.py4
-rw-r--r--tests/roots/test-ext-autodoc/circular_import/c.py6
-rw-r--r--tests/roots/test-ext-autodoc/conf.py15
-rw-r--r--tests/roots/test-ext-autodoc/index.rst15
-rw-r--r--tests/roots/test-ext-autodoc/target/TYPE_CHECKING.py16
-rw-r--r--tests/roots/test-ext-autodoc/target/__init__.py204
-rw-r--r--tests/roots/test-ext-autodoc/target/_functions_to_import.py8
-rw-r--r--tests/roots/test-ext-autodoc/target/abstractmethods.py29
-rw-r--r--tests/roots/test-ext-autodoc/target/annotated.py8
-rw-r--r--tests/roots/test-ext-autodoc/target/autoclass_content.py47
-rw-r--r--tests/roots/test-ext-autodoc/target/autodoc_type_aliases.py49
-rw-r--r--tests/roots/test-ext-autodoc/target/bound_method.py7
-rw-r--r--tests/roots/test-ext-autodoc/target/cached_property.py12
-rw-r--r--tests/roots/test-ext-autodoc/target/callable.py13
-rw-r--r--tests/roots/test-ext-autodoc/target/canonical/__init__.py1
-rw-r--r--tests/roots/test-ext-autodoc/target/canonical/original.py15
-rw-r--r--tests/roots/test-ext-autodoc/target/classes.py44
-rw-r--r--tests/roots/test-ext-autodoc/target/coroutine.py37
-rw-r--r--tests/roots/test-ext-autodoc/target/cython.pyx13
-rw-r--r--tests/roots/test-ext-autodoc/target/decorator.py53
-rw-r--r--tests/roots/test-ext-autodoc/target/descriptor.py31
-rw-r--r--tests/roots/test-ext-autodoc/target/docstring_signature.py33
-rw-r--r--tests/roots/test-ext-autodoc/target/empty_all.py16
-rw-r--r--tests/roots/test-ext-autodoc/target/enums.py23
-rw-r--r--tests/roots/test-ext-autodoc/target/final.py16
-rw-r--r--tests/roots/test-ext-autodoc/target/functions.py19
-rw-r--r--tests/roots/test-ext-autodoc/target/generic_class.py13
-rw-r--r--tests/roots/test-ext-autodoc/target/genericalias.py16
-rw-r--r--tests/roots/test-ext-autodoc/target/hide_value.py19
-rw-r--r--tests/roots/test-ext-autodoc/target/imported_members.py1
-rw-r--r--tests/roots/test-ext-autodoc/target/inheritance.py25
-rw-r--r--tests/roots/test-ext-autodoc/target/instance_variable.py11
-rw-r--r--tests/roots/test-ext-autodoc/target/literal.py24
-rw-r--r--tests/roots/test-ext-autodoc/target/metadata.py2
-rw-r--r--tests/roots/test-ext-autodoc/target/methods.py29
-rw-r--r--tests/roots/test-ext-autodoc/target/module.py14
-rw-r--r--tests/roots/test-ext-autodoc/target/name_conflict/__init__.py6
-rw-r--r--tests/roots/test-ext-autodoc/target/name_conflict/foo.py2
-rw-r--r--tests/roots/test-ext-autodoc/target/name_mangling.py11
-rw-r--r--tests/roots/test-ext-autodoc/target/need_mocks.py42
-rw-r--r--tests/roots/test-ext-autodoc/target/overload.py90
-rw-r--r--tests/roots/test-ext-autodoc/target/overload2.py5
-rw-r--r--tests/roots/test-ext-autodoc/target/partialfunction.py12
-rw-r--r--tests/roots/test-ext-autodoc/target/partialmethod.py17
-rw-r--r--tests/roots/test-ext-autodoc/target/pep570.py0
-rw-r--r--tests/roots/test-ext-autodoc/target/pep604.py16
-rw-r--r--tests/roots/test-ext-autodoc/target/preserve_defaults.py60
-rw-r--r--tests/roots/test-ext-autodoc/target/preserve_defaults_special_constructs.py50
-rw-r--r--tests/roots/test-ext-autodoc/target/private.py27
-rw-r--r--tests/roots/test-ext-autodoc/target/process_docstring.py8
-rw-r--r--tests/roots/test-ext-autodoc/target/properties.py22
-rw-r--r--tests/roots/test-ext-autodoc/target/singledispatch.py36
-rw-r--r--tests/roots/test-ext-autodoc/target/singledispatchmethod.py27
-rw-r--r--tests/roots/test-ext-autodoc/target/slots.py22
-rw-r--r--tests/roots/test-ext-autodoc/target/sort_by_all.py25
-rw-r--r--tests/roots/test-ext-autodoc/target/typed_vars.py34
-rw-r--r--tests/roots/test-ext-autodoc/target/typehints.py105
-rw-r--r--tests/roots/test-ext-autodoc/target/typevar.py32
-rw-r--r--tests/roots/test-ext-autodoc/target/uninitialized_attributes.py8
-rw-r--r--tests/roots/test-ext-autodoc/target/wrappedfunction.py17
-rw-r--r--tests/roots/test-ext-autosectionlabel-prefix-document/conf.py2
-rw-r--r--tests/roots/test-ext-autosectionlabel-prefix-document/index.rst37
-rw-r--r--tests/roots/test-ext-autosectionlabel/conf.py1
-rw-r--r--tests/roots/test-ext-autosectionlabel/index.rst37
-rw-r--r--tests/roots/test-ext-autosummary-filename-map/autosummary_dummy_module.py23
-rw-r--r--tests/roots/test-ext-autosummary-filename-map/conf.py11
-rw-r--r--tests/roots/test-ext-autosummary-filename-map/index.rst9
-rw-r--r--tests/roots/test-ext-autosummary-imported_members/autosummary_dummy_package/__init__.py1
-rw-r--r--tests/roots/test-ext-autosummary-imported_members/autosummary_dummy_package/autosummary_dummy_module.py8
-rw-r--r--tests/roots/test-ext-autosummary-imported_members/conf.py8
-rw-r--r--tests/roots/test-ext-autosummary-imported_members/index.rst7
-rw-r--r--tests/roots/test-ext-autosummary-mock_imports/conf.py8
-rw-r--r--tests/roots/test-ext-autosummary-mock_imports/foo.py6
-rw-r--r--tests/roots/test-ext-autosummary-mock_imports/index.rst7
-rw-r--r--tests/roots/test-ext-autosummary-module_all/autosummary_dummy_package_all/__init__.py13
-rw-r--r--tests/roots/test-ext-autosummary-module_all/autosummary_dummy_package_all/autosummary_dummy_module.py20
-rw-r--r--tests/roots/test-ext-autosummary-module_all/autosummary_dummy_package_all/extra_dummy_module.py20
-rw-r--r--tests/roots/test-ext-autosummary-module_all/conf.py8
-rw-r--r--tests/roots/test-ext-autosummary-module_all/index.rst8
-rw-r--r--tests/roots/test-ext-autosummary-recursive/conf.py7
-rw-r--r--tests/roots/test-ext-autosummary-recursive/index.rst15
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package/__init__.py0
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package/module.py13
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package/module_importfail.py2
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package/package/__init__.py0
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package/package/module.py13
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package2/__init__.py0
-rw-r--r--tests/roots/test-ext-autosummary-recursive/package2/module.py13
-rw-r--r--tests/roots/test-ext-autosummary-skip-member/conf.py20
-rw-r--r--tests/roots/test-ext-autosummary-skip-member/index.rst4
-rw-r--r--tests/roots/test-ext-autosummary-skip-member/target.py14
-rw-r--r--tests/roots/test-ext-autosummary-template/_templates/empty.rst1
-rw-r--r--tests/roots/test-ext-autosummary-template/conf.py10
-rw-r--r--tests/roots/test-ext-autosummary-template/index.rst5
-rw-r--r--tests/roots/test-ext-autosummary-template/target.py2
-rw-r--r--tests/roots/test-ext-autosummary/autosummary_class_module.py2
-rw-r--r--tests/roots/test-ext-autosummary/autosummary_dummy_inherited_module.py13
-rw-r--r--tests/roots/test-ext-autosummary/autosummary_dummy_module.py68
-rw-r--r--tests/roots/test-ext-autosummary/autosummary_importfail.py2
-rw-r--r--tests/roots/test-ext-autosummary/conf.py10
-rw-r--r--tests/roots/test-ext-autosummary/index.rst18
-rw-r--r--tests/roots/test-ext-coverage/conf.py12
-rw-r--r--tests/roots/test-ext-coverage/coverage_ignored.py22
-rw-r--r--tests/roots/test-ext-coverage/coverage_not_ignored.py22
-rw-r--r--tests/roots/test-ext-coverage/index.rst6
-rw-r--r--tests/roots/test-ext-doctest-skipif/conf.py16
-rw-r--r--tests/roots/test-ext-doctest-skipif/skipif.txt81
-rw-r--r--tests/roots/test-ext-doctest-with-autodoc/conf.py7
-rw-r--r--tests/roots/test-ext-doctest-with-autodoc/dir/__init__.py0
-rw-r--r--tests/roots/test-ext-doctest-with-autodoc/dir/bar.py4
-rw-r--r--tests/roots/test-ext-doctest-with-autodoc/dir/inner.rst4
-rw-r--r--tests/roots/test-ext-doctest-with-autodoc/foo.py5
-rw-r--r--tests/roots/test-ext-doctest-with-autodoc/index.rst4
-rw-r--r--tests/roots/test-ext-doctest/conf.py6
-rw-r--r--tests/roots/test-ext-doctest/doctest.txt163
-rw-r--r--tests/roots/test-ext-extlinks-hardcoded-urls-multiple-replacements/conf.py6
-rw-r--r--tests/roots/test-ext-extlinks-hardcoded-urls-multiple-replacements/index.rst24
-rw-r--r--tests/roots/test-ext-extlinks-hardcoded-urls/conf.py3
-rw-r--r--tests/roots/test-ext-extlinks-hardcoded-urls/index.rst28
-rw-r--r--tests/roots/test-ext-githubpages/conf.py1
-rw-r--r--tests/roots/test-ext-githubpages/index.rst3
-rw-r--r--tests/roots/test-ext-graphviz/_static/images/test.svg8
-rw-r--r--tests/roots/test-ext-graphviz/conf.py3
-rw-r--r--tests/roots/test-ext-graphviz/graph.dot3
-rw-r--r--tests/roots/test-ext-graphviz/graph.xx.dot3
-rw-r--r--tests/roots/test-ext-graphviz/index.rst43
-rw-r--r--tests/roots/test-ext-ifconfig/conf.py10
-rw-r--r--tests/roots/test-ext-ifconfig/index.rst21
-rw-r--r--tests/roots/test-ext-imgconverter/conf.py1
-rw-r--r--tests/roots/test-ext-imgconverter/img.pdfbin0 -> 141783 bytes
-rw-r--r--tests/roots/test-ext-imgconverter/index.rst5
-rw-r--r--tests/roots/test-ext-imgconverter/svgimg.svg4
-rw-r--r--tests/roots/test-ext-imgmockconverter/1/svgimg.svg3
-rw-r--r--tests/roots/test-ext-imgmockconverter/2/svgimg.svg4
-rw-r--r--tests/roots/test-ext-imgmockconverter/conf.py5
-rw-r--r--tests/roots/test-ext-imgmockconverter/index.rst6
-rw-r--r--tests/roots/test-ext-imgmockconverter/mocksvgconverter.py39
-rw-r--r--tests/roots/test-ext-inheritance_diagram/conf.py6
-rw-r--r--tests/roots/test-ext-inheritance_diagram/example/__init__.py1
-rw-r--r--tests/roots/test-ext-inheritance_diagram/example/sphinx.py5
-rw-r--r--tests/roots/test-ext-inheritance_diagram/external/other.py5
-rw-r--r--tests/roots/test-ext-inheritance_diagram/index.rst18
-rw-r--r--tests/roots/test-ext-inheritance_diagram/subdir/page1.rst9
-rw-r--r--tests/roots/test-ext-inheritance_diagram/subdir/page2.rst5
-rw-r--r--tests/roots/test-ext-inheritance_diagram/test.py22
-rw-r--r--tests/roots/test-ext-intersphinx-cppdomain/conf.py1
-rw-r--r--tests/roots/test-ext-intersphinx-cppdomain/index.rst8
-rw-r--r--tests/roots/test-ext-intersphinx-role/conf.py3
-rw-r--r--tests/roots/test-ext-intersphinx-role/index.rst44
-rw-r--r--tests/roots/test-ext-math-compat/conf.py20
-rw-r--r--tests/roots/test-ext-math-compat/index.rst21
-rw-r--r--tests/roots/test-ext-math-simple/conf.py0
-rw-r--r--tests/roots/test-ext-math-simple/index.rst4
-rw-r--r--tests/roots/test-ext-math/conf.py0
-rw-r--r--tests/roots/test-ext-math/index.rst25
-rw-r--r--tests/roots/test-ext-math/math.rst31
-rw-r--r--tests/roots/test-ext-math/nomath.rst0
-rw-r--r--tests/roots/test-ext-math/page.rst9
-rw-r--r--tests/roots/test-ext-napoleon/conf.py5
-rw-r--r--tests/roots/test-ext-napoleon/index.rst6
-rw-r--r--tests/roots/test-ext-napoleon/mypackage/__init__.py0
-rw-r--r--tests/roots/test-ext-napoleon/mypackage/typehints.py11
-rw-r--r--tests/roots/test-ext-napoleon/typehints.rst5
-rw-r--r--tests/roots/test-ext-todo/bar.rst4
-rw-r--r--tests/roots/test-ext-todo/conf.py1
-rw-r--r--tests/roots/test-ext-todo/foo.rst10
-rw-r--r--tests/roots/test-ext-todo/index.rst11
-rw-r--r--tests/roots/test-ext-viewcode-find/conf.py3
-rw-r--r--tests/roots/test-ext-viewcode-find/index.rst38
-rw-r--r--tests/roots/test-ext-viewcode-find/not_a_package/__init__.py1
-rw-r--r--tests/roots/test-ext-viewcode-find/not_a_package/submodule.py31
-rw-r--r--tests/roots/test-ext-viewcode/conf.py24
-rw-r--r--tests/roots/test-ext-viewcode/index.rst39
-rw-r--r--tests/roots/test-ext-viewcode/objects.rst169
-rw-r--r--tests/roots/test-ext-viewcode/spam/__init__.py2
-rw-r--r--tests/roots/test-ext-viewcode/spam/mod1.py30
-rw-r--r--tests/roots/test-ext-viewcode/spam/mod2.py22
-rw-r--r--tests/roots/test-ext-viewcode/spam/mod3.py3
-rw-r--r--tests/roots/test-extensions/conf.py4
-rw-r--r--tests/roots/test-extensions/read_parallel.py4
-rw-r--r--tests/roots/test-extensions/read_serial.py4
-rw-r--r--tests/roots/test-extensions/write_parallel.py4
-rw-r--r--tests/roots/test-extensions/write_serial.py4
-rw-r--r--tests/roots/test-footnotes/bar.rst6
-rw-r--r--tests/roots/test-footnotes/baz.rst6
-rw-r--r--tests/roots/test-footnotes/conf.py1
-rw-r--r--tests/roots/test-footnotes/index.rst188
-rw-r--r--tests/roots/test-footnotes/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-gettext-template/_templates/template1.html5
-rw-r--r--tests/roots/test-gettext-template/_templates/template2.html5
-rw-r--r--tests/roots/test-gettext-template/conf.py1
-rw-r--r--tests/roots/test-gettext-template/index.rst0
-rw-r--r--tests/roots/test-glossary/conf.py0
-rw-r--r--tests/roots/test-glossary/index.rst22
-rw-r--r--tests/roots/test-highlight_options/conf.py4
-rw-r--r--tests/roots/test-highlight_options/index.rst14
-rw-r--r--tests/roots/test-html_assets/conf.py12
-rw-r--r--tests/roots/test-html_assets/extra/.htaccess0
-rw-r--r--tests/roots/test-html_assets/extra/.htpasswd0
-rw-r--r--tests/roots/test-html_assets/extra/API.html_t1
-rw-r--r--tests/roots/test-html_assets/extra/css/style.css0
-rw-r--r--tests/roots/test-html_assets/extra/index.rst0
-rw-r--r--tests/roots/test-html_assets/extra/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-html_assets/extra/subdir/.htaccess0
-rw-r--r--tests/roots/test-html_assets/extra/subdir/.htpasswd0
-rw-r--r--tests/roots/test-html_assets/index.rst3
-rw-r--r--tests/roots/test-html_assets/static/.htaccess0
-rw-r--r--tests/roots/test-html_assets/static/.htpasswd0
-rw-r--r--tests/roots/test-html_assets/static/API.html_t1
-rw-r--r--tests/roots/test-html_assets/static/css/style.css0
-rw-r--r--tests/roots/test-html_assets/static/index.rst0
-rw-r--r--tests/roots/test-html_assets/static/js/custom.js0
-rw-r--r--tests/roots/test-html_assets/static/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-html_assets/static/subdir/.htaccess0
-rw-r--r--tests/roots/test-html_assets/static/subdir/.htpasswd0
-rw-r--r--tests/roots/test-html_assets/subdir/_build/index.html0
-rw-r--r--tests/roots/test-html_assets/subdir/background.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-html_entity/conf.py2
-rw-r--r--tests/roots/test-html_entity/index.rst31
-rw-r--r--tests/roots/test-html_file_checksum/conf.py1
-rw-r--r--tests/roots/test-html_file_checksum/index.rst0
-rw-r--r--tests/roots/test-html_file_checksum/static/empty.js0
-rw-r--r--tests/roots/test-html_file_checksum/static/script.js1
-rw-r--r--tests/roots/test-html_file_checksum/static/stylesheet-a.css1
-rw-r--r--tests/roots/test-html_file_checksum/static/stylesheet-b.css1
-rw-r--r--tests/roots/test-html_scaled_image_link/conf.py0
-rw-r--r--tests/roots/test-html_scaled_image_link/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-html_scaled_image_link/index.rst11
-rw-r--r--tests/roots/test-html_signaturereturn_icon/conf.py1
-rw-r--r--tests/roots/test-html_signaturereturn_icon/index.rst4
-rw-r--r--tests/roots/test-html_style/_static/default.css0
-rw-r--r--tests/roots/test-html_style/conf.py2
-rw-r--r--tests/roots/test-html_style/index.rst2
-rw-r--r--tests/roots/test-image-escape/conf.py0
-rw-r--r--tests/roots/test-image-escape/img_#1.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-image-escape/index.rst5
-rw-r--r--tests/roots/test-image-in-parsed-literal/conf.py9
-rw-r--r--tests/roots/test-image-in-parsed-literal/index.rst9
-rw-r--r--tests/roots/test-image-in-parsed-literal/pic.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-image-in-section/conf.py8
-rw-r--r--tests/roots/test-image-in-section/index.rst22
-rw-r--r--tests/roots/test-image-in-section/pic.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-images/conf.py0
-rw-r--r--tests/roots/test-images/img.gifbin0 -> 24976 bytes
-rw-r--r--tests/roots/test-images/img.ja.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-images/img.pdfbin0 -> 141783 bytes
-rw-r--r--tests/roots/test-images/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-images/img.zh.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-images/index.rst29
-rw-r--r--tests/roots/test-images/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-images/rimg.png.xxbin0 -> 218 bytes
-rw-r--r--tests/roots/test-images/rimg.xx.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-images/subdir/index.rst10
-rw-r--r--tests/roots/test-images/subdir/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-images/subdir/rimg.xx.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-images/subdir/svgimg.pdfbin0 -> 141783 bytes
-rw-r--r--tests/roots/test-images/subdir/svgimg.svg4
-rw-r--r--tests/roots/test-images/subdir/svgimg.xx.svg4
-rw-r--r--tests/roots/test-images/testimäge.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-index_on_title/conf.py0
-rw-r--r--tests/roots/test-index_on_title/contents.rst5
-rw-r--r--tests/roots/test-inheritance/basic_diagram.rst5
-rw-r--r--tests/roots/test-inheritance/conf.py7
-rw-r--r--tests/roots/test-inheritance/diagram_module_w_2_top_classes.rst6
-rw-r--r--tests/roots/test-inheritance/diagram_w_1_top_class.rst7
-rw-r--r--tests/roots/test-inheritance/diagram_w_2_top_classes.rst9
-rw-r--r--tests/roots/test-inheritance/diagram_w_nested_classes.rst5
-rw-r--r--tests/roots/test-inheritance/diagram_w_parts.rst7
-rw-r--r--tests/roots/test-inheritance/dummy/__init__.py0
-rw-r--r--tests/roots/test-inheritance/dummy/test.py35
-rw-r--r--tests/roots/test-inheritance/dummy/test_nested.py11
-rw-r--r--tests/roots/test-inheritance/index.rst4
-rw-r--r--tests/roots/test-intl/_templates/contents.html10
-rw-r--r--tests/roots/test-intl/admonitions.txt50
-rw-r--r--tests/roots/test-intl/bom.txt5
-rw-r--r--tests/roots/test-intl/conf.py8
-rw-r--r--tests/roots/test-intl/definition_terms.txt16
-rw-r--r--tests/roots/test-intl/docfields.txt46
-rw-r--r--tests/roots/test-intl/external_links.txt35
-rw-r--r--tests/roots/test-intl/figure.txt53
-rw-r--r--tests/roots/test-intl/footnote.txt14
-rw-r--r--tests/roots/test-intl/glossary_terms.txt29
-rw-r--r--tests/roots/test-intl/glossary_terms_inconsistency.txt6
-rw-r--r--tests/roots/test-intl/i18n.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-intl/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-intl/index.txt40
-rw-r--r--tests/roots/test-intl/index_entries.txt24
-rw-r--r--tests/roots/test-intl/label_target.txt67
-rw-r--r--tests/roots/test-intl/literalblock.txt71
-rw-r--r--tests/roots/test-intl/noqa.txt16
-rw-r--r--tests/roots/test-intl/only.txt14
-rw-r--r--tests/roots/test-intl/raw.txt8
-rw-r--r--tests/roots/test-intl/refs.txt48
-rw-r--r--tests/roots/test-intl/refs_inconsistency.txt13
-rw-r--r--tests/roots/test-intl/refs_python_domain.txt15
-rw-r--r--tests/roots/test-intl/role_xref.txt40
-rw-r--r--tests/roots/test-intl/rubric.txt14
-rw-r--r--tests/roots/test-intl/section.txt8
-rw-r--r--tests/roots/test-intl/seealso.txt15
-rw-r--r--tests/roots/test-intl/subdir/index.txt2
-rw-r--r--tests/roots/test-intl/table.txt20
-rw-r--r--tests/roots/test-intl/toctree.txt10
-rw-r--r--tests/roots/test-intl/topic.txt13
-rw-r--r--tests/roots/test-intl/translation_progress.txt40
-rw-r--r--tests/roots/test-intl/versionchange.txt16
-rw-r--r--tests/roots/test-intl/warnings.txt5
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/admonitions.po84
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/bom.po12
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/definition_terms.po47
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/docfields.po39
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/external_links.po47
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/figure.po57
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/footnote.po40
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/glossary_terms.po59
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/glossary_terms_inconsistency.po23
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/index.po29
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/index_entries.po77
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/label_target.po66
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/literalblock.po103
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/noqa.po46
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/only.po29
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/raw.po21
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/refs.po85
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/refs_inconsistency.po39
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/refs_python_domain.po25
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/role_xref.po47
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/rubric.po29
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/section.po28
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/seealso.po33
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/sphinx.po23
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/table.po54
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/toctree.po31
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/topic.po31
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/translation_progress.po57
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/versionchange.po33
-rw-r--r--tests/roots/test-intl/xx/LC_MESSAGES/warnings.po23
-rw-r--r--tests/roots/test-intl_substitution_definitions/conf.py13
-rw-r--r--tests/roots/test-intl_substitution_definitions/i18n.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-intl_substitution_definitions/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-intl_substitution_definitions/index.rst10
-rw-r--r--tests/roots/test-intl_substitution_definitions/prolog_epilog_substitution.rst12
-rw-r--r--tests/roots/test-intl_substitution_definitions/prolog_epilog_substitution_excluded.rst6
-rw-r--r--tests/roots/test-intl_substitution_definitions/xx/LC_MESSAGES/prolog_epilog_substitution.po38
-rw-r--r--tests/roots/test-keep_warnings/conf.py1
-rw-r--r--tests/roots/test-keep_warnings/index.rst2
-rw-r--r--tests/roots/test-latex-babel/bar.rst4
-rw-r--r--tests/roots/test-latex-babel/conf.py5
-rw-r--r--tests/roots/test-latex-babel/foo.rst4
-rw-r--r--tests/roots/test-latex-babel/index.rst8
-rw-r--r--tests/roots/test-latex-container/conf.py0
-rw-r--r--tests/roots/test-latex-container/index.rst4
-rw-r--r--tests/roots/test-latex-equations/conf.py2
-rw-r--r--tests/roots/test-latex-equations/equations.rst21
-rw-r--r--tests/roots/test-latex-equations/expects/latex-equations.tex18
-rw-r--r--tests/roots/test-latex-figure-in-admonition/conf.py1
-rw-r--r--tests/roots/test-latex-figure-in-admonition/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-latex-figure-in-admonition/index.rst9
-rw-r--r--tests/roots/test-latex-includegraphics/conf.py47
-rw-r--r--tests/roots/test-latex-includegraphics/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-latex-includegraphics/index.rst37
-rw-r--r--tests/roots/test-latex-includegraphics/sphinx.pngbin0 -> 34213 bytes
-rw-r--r--tests/roots/test-latex-includegraphics/tall.pngbin0 -> 38192 bytes
-rw-r--r--tests/roots/test-latex-index/conf.py0
-rw-r--r--tests/roots/test-latex-index/index.rst16
-rw-r--r--tests/roots/test-latex-labels-before-module/automodule1.py2
-rw-r--r--tests/roots/test-latex-labels-before-module/automodule2a.py2
-rw-r--r--tests/roots/test-latex-labels-before-module/automodule2b.py2
-rw-r--r--tests/roots/test-latex-labels-before-module/automodule3.py2
-rw-r--r--tests/roots/test-latex-labels-before-module/conf.py8
-rw-r--r--tests/roots/test-latex-labels-before-module/index.rst48
-rw-r--r--tests/roots/test-latex-labels/conf.py0
-rw-r--r--tests/roots/test-latex-labels/index.rst72
-rw-r--r--tests/roots/test-latex-labels/otherdoc.rst2
-rw-r--r--tests/roots/test-latex-numfig/conf.py8
-rw-r--r--tests/roots/test-latex-numfig/index.rst9
-rw-r--r--tests/roots/test-latex-numfig/indexhowto.rst10
-rw-r--r--tests/roots/test-latex-numfig/indexmanual.rst13
-rw-r--r--tests/roots/test-latex-table/_mytemplates/latex/longtable.tex_t1
-rw-r--r--tests/roots/test-latex-table/complex.rst58
-rw-r--r--tests/roots/test-latex-table/conf.py0
-rw-r--r--tests/roots/test-latex-table/expects/complex_spanning_cell.tex69
-rw-r--r--tests/roots/test-latex-table/expects/gridtable.tex73
-rw-r--r--tests/roots/test-latex-table/expects/gridtable_with_tabularcolumn.tex73
-rw-r--r--tests/roots/test-latex-table/expects/longtable.tex70
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_align.tex69
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_caption.tex71
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_problematic_cell.tex76
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_stub_columns_and_problematic_cell.tex81
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_verbatim.tex70
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_widths.tex73
-rw-r--r--tests/roots/test-latex-table/expects/longtable_having_widths_and_problematic_cell.tex76
-rw-r--r--tests/roots/test-latex-table/expects/longtable_with_tabularcolumn.tex70
-rw-r--r--tests/roots/test-latex-table/expects/simple_table.tex40
-rw-r--r--tests/roots/test-latex-table/expects/table_having_caption.tex44
-rw-r--r--tests/roots/test-latex-table/expects/table_having_problematic_cell.tex47
-rw-r--r--tests/roots/test-latex-table/expects/table_having_stub_columns_and_problematic_cell.tex49
-rw-r--r--tests/roots/test-latex-table/expects/table_having_threeparagraphs_cell_in_first_col.tex26
-rw-r--r--tests/roots/test-latex-table/expects/table_having_verbatim.tex41
-rw-r--r--tests/roots/test-latex-table/expects/table_having_widths.tex46
-rw-r--r--tests/roots/test-latex-table/expects/table_having_widths_and_problematic_cell.tex47
-rw-r--r--tests/roots/test-latex-table/expects/tabular_having_widths.tex40
-rw-r--r--tests/roots/test-latex-table/expects/tabularcolumn.tex41
-rw-r--r--tests/roots/test-latex-table/expects/tabulary_having_widths.tex40
-rw-r--r--tests/roots/test-latex-table/index.rst8
-rw-r--r--tests/roots/test-latex-table/longtable.rst156
-rw-r--r--tests/roots/test-latex-table/tabular.rst173
-rw-r--r--tests/roots/test-latex-theme/conf.py2
-rw-r--r--tests/roots/test-latex-theme/index.rst2
-rw-r--r--tests/roots/test-latex-theme/theme/custom/theme.conf6
-rw-r--r--tests/roots/test-latex-title/conf.py4
-rw-r--r--tests/roots/test-latex-title/index.rst12
-rw-r--r--tests/roots/test-latex-unicode/conf.py0
-rw-r--r--tests/roots/test-latex-unicode/index.rst7
-rw-r--r--tests/roots/test-linkcheck-anchors-ignore-for-url/conf.py3
-rw-r--r--tests/roots/test-linkcheck-anchors-ignore-for-url/index.rst7
-rw-r--r--tests/roots/test-linkcheck-anchors-ignore/conf.py3
-rw-r--r--tests/roots/test-linkcheck-anchors-ignore/index.rst2
-rw-r--r--tests/roots/test-linkcheck-documents_exclude/br0ken_link.rst5
-rw-r--r--tests/roots/test-linkcheck-documents_exclude/broken_link.rst5
-rw-r--r--tests/roots/test-linkcheck-documents_exclude/conf.py6
-rw-r--r--tests/roots/test-linkcheck-documents_exclude/index.rst3
-rw-r--r--tests/roots/test-linkcheck-localserver-anchor/conf.py3
-rw-r--r--tests/roots/test-linkcheck-localserver-anchor/index.rst1
-rw-r--r--tests/roots/test-linkcheck-localserver-https/conf.py2
-rw-r--r--tests/roots/test-linkcheck-localserver-https/index.rst1
-rw-r--r--tests/roots/test-linkcheck-localserver-warn-redirects/conf.py2
-rw-r--r--tests/roots/test-linkcheck-localserver-warn-redirects/index.rst3
-rw-r--r--tests/roots/test-linkcheck-localserver/conf.py2
-rw-r--r--tests/roots/test-linkcheck-localserver/index.rst1
-rw-r--r--tests/roots/test-linkcheck-raw-node/conf.py2
-rw-r--r--tests/roots/test-linkcheck-raw-node/index.rst2
-rw-r--r--tests/roots/test-linkcheck-too-many-retries/conf.py3
-rw-r--r--tests/roots/test-linkcheck-too-many-retries/index.rst1
-rw-r--r--tests/roots/test-linkcheck/conf.py4
-rw-r--r--tests/roots/test-linkcheck/links.rst14
-rw-r--r--tests/roots/test-local-logo/conf.py4
-rw-r--r--tests/roots/test-local-logo/images/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-local-logo/index.rst31
-rw-r--r--tests/roots/test-locale/locale1/en/LC_MESSAGES/myext.mobin0 -> 80 bytes
-rw-r--r--tests/roots/test-locale/locale1/en/LC_MESSAGES/myext.po2
-rw-r--r--tests/roots/test-locale/locale1/et/LC_MESSAGES/myext.mobin0 -> 80 bytes
-rw-r--r--tests/roots/test-locale/locale1/et/LC_MESSAGES/myext.po2
-rw-r--r--tests/roots/test-locale/locale2/en/LC_MESSAGES/myext.mobin0 -> 82 bytes
-rw-r--r--tests/roots/test-locale/locale2/en/LC_MESSAGES/myext.po2
-rw-r--r--tests/roots/test-manpage_url/conf.py1
-rw-r--r--tests/roots/test-manpage_url/index.rst3
-rw-r--r--tests/roots/test-markup-citation/conf.py3
-rw-r--r--tests/roots/test-markup-citation/index.rst9
-rw-r--r--tests/roots/test-markup-rubric/conf.py3
-rw-r--r--tests/roots/test-markup-rubric/index.rst7
-rw-r--r--tests/roots/test-maxlistdepth/conf.py5
-rw-r--r--tests/roots/test-maxlistdepth/index.rst57
-rw-r--r--tests/roots/test-metadata/conf.py0
-rw-r--r--tests/roots/test-metadata/index.rst46
-rw-r--r--tests/roots/test-need-escaped/bar.rst2
-rw-r--r--tests/roots/test-need-escaped/baz.rst2
-rw-r--r--tests/roots/test-need-escaped/conf.py2
-rw-r--r--tests/roots/test-need-escaped/foo.rst15
-rw-r--r--tests/roots/test-need-escaped/index.rst30
-rw-r--r--tests/roots/test-need-escaped/quux.rst2
-rw-r--r--tests/roots/test-need-escaped/qux.rst1
-rw-r--r--tests/roots/test-nested-enumerated-list/conf.py0
-rw-r--r--tests/roots/test-nested-enumerated-list/index.rst21
-rw-r--r--tests/roots/test-nested-tables/conf.py0
-rw-r--r--tests/roots/test-nested-tables/index.rst16
-rw-r--r--tests/roots/test-nitpicky-warnings/conf.py1
-rw-r--r--tests/roots/test-nitpicky-warnings/index.rst7
-rw-r--r--tests/roots/test-numbered-circular/conf.py1
-rw-r--r--tests/roots/test-numbered-circular/index.rst5
-rw-r--r--tests/roots/test-numbered-circular/sub.rst3
-rw-r--r--tests/roots/test-numfig/bar.rst66
-rw-r--r--tests/roots/test-numfig/baz.rst24
-rw-r--r--tests/roots/test-numfig/conf.py1
-rw-r--r--tests/roots/test-numfig/foo.rst81
-rw-r--r--tests/roots/test-numfig/index.rst59
-rw-r--r--tests/roots/test-numfig/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-object-description-sections/conf.py0
-rw-r--r--tests/roots/test-object-description-sections/index.rst6
-rw-r--r--tests/roots/test-productionlist/Bare.rst6
-rw-r--r--tests/roots/test-productionlist/Dup1.rst5
-rw-r--r--tests/roots/test-productionlist/Dup2.rst5
-rw-r--r--tests/roots/test-productionlist/LineContinuation.rst6
-rw-r--r--tests/roots/test-productionlist/P1.rst6
-rw-r--r--tests/roots/test-productionlist/P2.rst6
-rw-r--r--tests/roots/test-productionlist/conf.py1
-rw-r--r--tests/roots/test-productionlist/firstLineRule.rst5
-rw-r--r--tests/roots/test-productionlist/index.rst27
-rw-r--r--tests/roots/test-prolog/conf.py10
-rw-r--r--tests/roots/test-prolog/index.rst7
-rw-r--r--tests/roots/test-prolog/markdown.md3
-rw-r--r--tests/roots/test-prolog/prolog_markdown_parser.py13
-rw-r--r--tests/roots/test-prolog/restructuredtext.rst4
-rw-r--r--tests/roots/test-pycode/cp_1251_coded.py4
-rw-r--r--tests/roots/test-reST-code-block/conf.py0
-rw-r--r--tests/roots/test-reST-code-block/index.rst7
-rw-r--r--tests/roots/test-reST-code-role/conf.py0
-rw-r--r--tests/roots/test-reST-code-role/index.rst9
-rw-r--r--tests/roots/test-refonly_bullet_list/conf.py1
-rw-r--r--tests/roots/test-refonly_bullet_list/index.rst14
-rw-r--r--tests/roots/test-remote-logo/conf.py5
-rw-r--r--tests/roots/test-remote-logo/index.rst31
-rw-r--r--tests/roots/test-roles-download/another/dummy.dat1
-rw-r--r--tests/roots/test-roles-download/conf.py3
-rw-r--r--tests/roots/test-roles-download/dummy.dat0
-rw-r--r--tests/roots/test-roles-download/index.rst7
-rw-r--r--tests/roots/test-root/Makefile67
-rw-r--r--tests/roots/test-root/_templates/contentssb.html2
-rw-r--r--tests/roots/test-root/_templates/customsb.html4
-rw-r--r--tests/roots/test-root/_templates/layout.html15
-rw-r--r--tests/roots/test-root/autodoc.txt39
-rw-r--r--tests/roots/test-root/autodoc_target.py221
-rw-r--r--tests/roots/test-root/bom.txt5
-rw-r--r--tests/roots/test-root/conf.py148
-rw-r--r--tests/roots/test-root/extapi.txt7
-rw-r--r--tests/roots/test-root/extensions.txt28
-rw-r--r--tests/roots/test-root/file_with_special_#_chars.xyz0
-rw-r--r--tests/roots/test-root/footnote.txt60
-rw-r--r--tests/roots/test-root/images.txt25
-rw-r--r--tests/roots/test-root/img.foo.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-root/img.gifbin0 -> 24976 bytes
-rw-r--r--tests/roots/test-root/img.pdfbin0 -> 141783 bytes
-rw-r--r--tests/roots/test-root/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-root/includes.txt102
-rw-r--r--tests/roots/test-root/index.txt65
-rw-r--r--tests/roots/test-root/lists.txt70
-rw-r--r--tests/roots/test-root/literal.inc13
-rw-r--r--tests/roots/test-root/literal_orig.inc12
-rw-r--r--tests/roots/test-root/markup.txt455
-rw-r--r--tests/roots/test-root/math.txt31
-rw-r--r--tests/roots/test-root/objects.txt262
-rw-r--r--tests/roots/test-root/otherext.foo2
-rw-r--r--tests/roots/test-root/parsermod.py14
-rw-r--r--tests/roots/test-root/quotes.inc1
-rw-r--r--tests/roots/test-root/rimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-root/special/api.h2
-rw-r--r--tests/roots/test-root/special/code.py2
-rw-r--r--tests/roots/test-root/subdir/excluded.txt2
-rw-r--r--tests/roots/test-root/subdir/images.txt6
-rw-r--r--tests/roots/test-root/subdir/img.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-root/subdir/include.inc5
-rw-r--r--tests/roots/test-root/subdir/includes.txt18
-rw-r--r--tests/roots/test-root/subdir/simg.pngbin0 -> 66247 bytes
-rw-r--r--tests/roots/test-root/svgimg.pdfbin0 -> 141783 bytes
-rw-r--r--tests/roots/test-root/svgimg.svg4
-rw-r--r--tests/roots/test-root/tabs.inc5
-rw-r--r--tests/roots/test-root/test.inc3
-rw-r--r--tests/roots/test-root/wrongenc.inc3
-rw-r--r--tests/roots/test-search/conf.py2
-rw-r--r--tests/roots/test-search/index.rst30
-rw-r--r--tests/roots/test-search/nosearch.rst7
-rw-r--r--tests/roots/test-search/tocitem.rst17
-rw-r--r--tests/roots/test-smartquotes/conf.py0
-rw-r--r--tests/roots/test-smartquotes/index.rst8
-rw-r--r--tests/roots/test-smartquotes/literals.rst12
-rw-r--r--tests/roots/test-stylesheets/_templates/layout.html8
-rw-r--r--tests/roots/test-stylesheets/conf.py9
-rw-r--r--tests/roots/test-stylesheets/index.rst4
-rw-r--r--tests/roots/test-templating/_templates/autosummary/class.rst9
-rw-r--r--tests/roots/test-templating/_templates/layout.html6
-rw-r--r--tests/roots/test-templating/autosummary_templating.txt7
-rw-r--r--tests/roots/test-templating/conf.py9
-rw-r--r--tests/roots/test-templating/index.txt7
-rw-r--r--tests/roots/test-theming/child.zipbin0 -> 661 bytes
-rw-r--r--tests/roots/test-theming/conf.py3
-rw-r--r--tests/roots/test-theming/index.rst5
-rw-r--r--tests/roots/test-theming/parent.zipbin0 -> 1039 bytes
-rw-r--r--tests/roots/test-theming/test_theme/__init__.py5
-rw-r--r--tests/roots/test-theming/test_theme/staticfiles/layout.html5
-rw-r--r--tests/roots/test-theming/test_theme/staticfiles/static/staticimg.pngbin0 -> 120 bytes
-rw-r--r--tests/roots/test-theming/test_theme/staticfiles/static/statictmpl.html_t2
-rw-r--r--tests/roots/test-theming/test_theme/staticfiles/theme.conf7
-rw-r--r--tests/roots/test-theming/test_theme/test-theme/theme.conf4
-rw-r--r--tests/roots/test-theming/ziptheme.zipbin0 -> 1039 bytes
-rw-r--r--tests/roots/test-tocdepth/bar.rst27
-rw-r--r--tests/roots/test-tocdepth/baz.rst5
-rw-r--r--tests/roots/test-tocdepth/conf.py2
-rw-r--r--tests/roots/test-tocdepth/foo.rst26
-rw-r--r--tests/roots/test-tocdepth/index.rst8
-rw-r--r--tests/roots/test-toctree-domain-objects/conf.py0
-rw-r--r--tests/roots/test-toctree-domain-objects/domains.rst39
-rw-r--r--tests/roots/test-toctree-domain-objects/index.rst6
-rw-r--r--tests/roots/test-toctree-duplicated/conf.py0
-rw-r--r--tests/roots/test-toctree-duplicated/foo.rst2
-rw-r--r--tests/roots/test-toctree-duplicated/index.rst7
-rw-r--r--tests/roots/test-toctree-empty/_templates/localtoc.html2
-rw-r--r--tests/roots/test-toctree-empty/conf.py2
-rw-r--r--tests/roots/test-toctree-empty/index.rst4
-rw-r--r--tests/roots/test-toctree-glob/bar/bar_1.rst4
-rw-r--r--tests/roots/test-toctree-glob/bar/bar_2.rst4
-rw-r--r--tests/roots/test-toctree-glob/bar/bar_3.rst4
-rw-r--r--tests/roots/test-toctree-glob/bar/bar_4/index.rst4
-rw-r--r--tests/roots/test-toctree-glob/bar/index.rst8
-rw-r--r--tests/roots/test-toctree-glob/baz.rst4
-rw-r--r--tests/roots/test-toctree-glob/conf.py1
-rw-r--r--tests/roots/test-toctree-glob/foo.rst4
-rw-r--r--tests/roots/test-toctree-glob/index.rst28
-rw-r--r--tests/roots/test-toctree-glob/quux.rst4
-rw-r--r--tests/roots/test-toctree-glob/qux/index.rst8
-rw-r--r--tests/roots/test-toctree-glob/qux/qux_1.rst4
-rw-r--r--tests/roots/test-toctree-glob/qux/qux_2.rst4
-rw-r--r--tests/roots/test-toctree-index/conf.py0
-rw-r--r--tests/roots/test-toctree-index/foo.rst8
-rw-r--r--tests/roots/test-toctree-index/index.rst15
-rw-r--r--tests/roots/test-toctree-maxdepth/bar.rst27
-rw-r--r--tests/roots/test-toctree-maxdepth/baz.rst5
-rw-r--r--tests/roots/test-toctree-maxdepth/conf.py1
-rw-r--r--tests/roots/test-toctree-maxdepth/foo.rst26
-rw-r--r--tests/roots/test-toctree-maxdepth/index.rst9
-rw-r--r--tests/roots/test-toctree-maxdepth/qux.rst9
-rw-r--r--tests/roots/test-toctree/bar.rst2
-rw-r--r--tests/roots/test-toctree/baz.rst2
-rw-r--r--tests/roots/test-toctree/conf.py0
-rw-r--r--tests/roots/test-toctree/foo.rst15
-rw-r--r--tests/roots/test-toctree/index.rst55
-rw-r--r--tests/roots/test-toctree/quux.rst2
-rw-r--r--tests/roots/test-toctree/qux.rst1
-rw-r--r--tests/roots/test-toctree/tocdepth.rst15
-rw-r--r--tests/roots/test-transforms-post_transforms-keyboard/conf.py0
-rw-r--r--tests/roots/test-transforms-post_transforms-keyboard/index.rst4
-rw-r--r--tests/roots/test-transforms-post_transforms-missing-reference/conf.py1
-rw-r--r--tests/roots/test-transforms-post_transforms-missing-reference/index.rst5
-rw-r--r--tests/roots/test-trim_doctest_flags/conf.py1
-rw-r--r--tests/roots/test-trim_doctest_flags/index.rst40
-rw-r--r--tests/roots/test-versioning/added.txt20
-rw-r--r--tests/roots/test-versioning/conf.py3
-rw-r--r--tests/roots/test-versioning/deleted.txt12
-rw-r--r--tests/roots/test-versioning/deleted_end.txt11
-rw-r--r--tests/roots/test-versioning/index.txt13
-rw-r--r--tests/roots/test-versioning/insert.txt18
-rw-r--r--tests/roots/test-versioning/insert_beginning.txt18
-rw-r--r--tests/roots/test-versioning/insert_similar.txt17
-rw-r--r--tests/roots/test-versioning/modified.txt17
-rw-r--r--tests/roots/test-versioning/original.txt15
-rw-r--r--tests/roots/test-warnings/autodoc_fodder.py6
-rw-r--r--tests/roots/test-warnings/conf.py6
-rw-r--r--tests/roots/test-warnings/index.rst45
-rw-r--r--tests/roots/test-warnings/svgimg.pdfbin0 -> 141783 bytes
-rw-r--r--tests/roots/test-warnings/svgimg.svg4
-rw-r--r--tests/roots/test-warnings/undecodable.rst3
-rw-r--r--tests/roots/test-warnings/wrongenc.inc3
-rw-r--r--tests/test_addnodes.py51
-rw-r--r--tests/test_api_translator.py92
-rw-r--r--tests/test_application.py152
-rw-r--r--tests/test_build.py135
-rw-r--r--tests/test_build_changes.py34
-rw-r--r--tests/test_build_dirhtml.py40
-rw-r--r--tests/test_build_epub.py411
-rw-r--r--tests/test_build_gettext.py235
-rw-r--r--tests/test_build_html.py1841
-rw-r--r--tests/test_build_latex.py1755
-rw-r--r--tests/test_build_linkcheck.py989
-rw-r--r--tests/test_build_manpage.py105
-rw-r--r--tests/test_build_texinfo.py155
-rw-r--r--tests/test_build_text.py278
-rw-r--r--tests/test_builder.py39
-rw-r--r--tests/test_catalogs.py74
-rw-r--r--tests/test_config.py517
-rw-r--r--tests/test_correct_year.py29
-rw-r--r--tests/test_directive_code.py595
-rw-r--r--tests/test_directive_object_description.py59
-rw-r--r--tests/test_directive_only.py46
-rw-r--r--tests/test_directive_other.py195
-rw-r--r--tests/test_directive_patch.py110
-rw-r--r--tests/test_directives_no_typesetting.py108
-rw-r--r--tests/test_docutilsconf.py29
-rw-r--r--tests/test_domain_c.py1076
-rw-r--r--tests/test_domain_cpp.py1744
-rw-r--r--tests/test_domain_js.py505
-rw-r--r--tests/test_domain_py.py2123
-rw-r--r--tests/test_domain_rst.py137
-rw-r--r--tests/test_domain_std.py495
-rw-r--r--tests/test_environment.py145
-rw-r--r--tests/test_environment_indexentries.py166
-rw-r--r--tests/test_environment_record_dependencies.py10
-rw-r--r--tests/test_environment_toctree.py396
-rw-r--r--tests/test_errors.py11
-rw-r--r--tests/test_events.py56
-rw-r--r--tests/test_ext_apidoc.py665
-rw-r--r--tests/test_ext_autodoc.py2537
-rw-r--r--tests/test_ext_autodoc_autoattribute.py176
-rw-r--r--tests/test_ext_autodoc_autoclass.py517
-rw-r--r--tests/test_ext_autodoc_autodata.py106
-rw-r--r--tests/test_ext_autodoc_autofunction.py201
-rw-r--r--tests/test_ext_autodoc_automodule.py192
-rw-r--r--tests/test_ext_autodoc_autoproperty.py91
-rw-r--r--tests/test_ext_autodoc_configs.py1727
-rw-r--r--tests/test_ext_autodoc_events.py118
-rw-r--r--tests/test_ext_autodoc_mock.py152
-rw-r--r--tests/test_ext_autodoc_preserve_defaults.py192
-rw-r--r--tests/test_ext_autodoc_private_members.py158
-rw-r--r--tests/test_ext_autosectionlabel.py77
-rw-r--r--tests/test_ext_autosummary.py686
-rw-r--r--tests/test_ext_coverage.py101
-rw-r--r--tests/test_ext_doctest.py136
-rw-r--r--tests/test_ext_duration.py14
-rw-r--r--tests/test_ext_extlinks.py45
-rw-r--r--tests/test_ext_githubpages.py26
-rw-r--r--tests/test_ext_graphviz.py196
-rw-r--r--tests/test_ext_ifconfig.py28
-rw-r--r--tests/test_ext_imgconverter.py34
-rw-r--r--tests/test_ext_imgmockconverter.py17
-rw-r--r--tests/test_ext_inheritance_diagram.py342
-rw-r--r--tests/test_ext_intersphinx.py568
-rw-r--r--tests/test_ext_math.py345
-rw-r--r--tests/test_ext_napoleon.py218
-rw-r--r--tests/test_ext_napoleon_docstring.py2660
-rw-r--r--tests/test_ext_todo.py109
-rw-r--r--tests/test_ext_viewcode.py137
-rw-r--r--tests/test_extension.py23
-rw-r--r--tests/test_highlighting.py104
-rw-r--r--tests/test_intl.py1527
-rw-r--r--tests/test_locale.py76
-rw-r--r--tests/test_markup.py619
-rw-r--r--tests/test_metadata.py43
-rw-r--r--tests/test_parser.py57
-rw-r--r--tests/test_project.py78
-rw-r--r--tests/test_pycode.py173
-rw-r--r--tests/test_pycode_ast.py62
-rw-r--r--tests/test_pycode_parser.py511
-rw-r--r--tests/test_quickstart.py260
-rw-r--r--tests/test_roles.py75
-rw-r--r--tests/test_search.py306
-rw-r--r--tests/test_smartquotes.py99
-rw-r--r--tests/test_templating.py41
-rw-r--r--tests/test_theming.py131
-rw-r--r--tests/test_toctree.py39
-rw-r--r--tests/test_transforms_move_module_targets.py77
-rw-r--r--tests/test_transforms_post_transforms.py268
-rw-r--r--tests/test_transforms_post_transforms_code.py44
-rw-r--r--tests/test_transforms_reorder_nodes.py96
-rw-r--r--tests/test_util.py73
-rw-r--r--tests/test_util_display.py103
-rw-r--r--tests/test_util_docstrings.py88
-rw-r--r--tests/test_util_docutils.py92
-rw-r--r--tests/test_util_fileutil.py103
-rw-r--r--tests/test_util_i18n.py190
-rw-r--r--tests/test_util_images.py74
-rw-r--r--tests/test_util_inspect.py869
-rw-r--r--tests/test_util_inventory.py116
-rw-r--r--tests/test_util_logging.py398
-rw-r--r--tests/test_util_matching.py174
-rw-r--r--tests/test_util_nodes.py254
-rw-r--r--tests/test_util_rst.py164
-rw-r--r--tests/test_util_template.py29
-rw-r--r--tests/test_util_typing.py536
-rw-r--r--tests/test_versioning.py120
-rw-r--r--tests/test_writer_latex.py28
-rw-r--r--tests/typing_test_data.py129
-rw-r--r--tests/utils.py55
-rw-r--r--tox.ini55
-rw-r--r--utils/CHANGES_template20
-rw-r--r--utils/__init__.py0
-rw-r--r--utils/babel_runner.py250
-rw-r--r--utils/bump_docker.py52
-rwxr-xr-xutils/bump_version.py183
-rw-r--r--utils/release-checklist70
1664 files changed, 442900 insertions, 0 deletions
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..786d28c
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,95 @@
+Maintainers
+===========
+
+*Listed alphabetically in forename, surname order*
+
+* Adam Turner <@AA-Turner>
+* Armin Ronacher <armin.ronacher@active-4.com>
+* Daniel Neuhäuser <@DasIch>
+* François Freitag <@francoisfreitag>
+* Georg Brandl <georg@python.org>
+* Jakob Lykke Andersen <@jakobandersen>
+* Jean-François Burnol <@jfbu>
+* Rob Ruana <@RobRuana>
+* Robert Lehmann <@lehmannro>
+* Stephen Finucane <@stephenfin>
+* Takayuki Shimizukawa <shimizukawa@gmail.com>
+* 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/CHANGES b/CHANGES
new file mode 100644
index 0000000..84c7abf
--- /dev/null
+++ b/CHANGES
@@ -0,0 +1,9019 @@
+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 </extdev/nodes>` 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 <table-of-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 <table-of-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 %}
+ <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
+ <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
+ {{ 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' <latexsphinxsetup>`
+ 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 ``<aside>`` element when
+ using Docutils 0.18 or later, to allow for easier styling. This matches the
+ behaviour introduced in Docutils 0.19. Patch by Adam Turner.
+* #10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.
+ Patch by Adam Turner.
+
+Bugs fixed
+----------
+
+* #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
+* #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due
+ to missing ``Node.findall()``
+* #10506: LaTeX: build error if highlighting inline code role in figure caption
+ (refs: #10251)
+* #10634: Make -P (pdb) option work better with exceptions triggered from events
+* #10550: py domain: Fix spurious whitespace in unparsing various operators (``+``,
+ ``-``, ``~``, and ``**``). Patch by Adam Turner (refs: #10551).
+* #10460: logging: Always show node source locations as absolute paths.
+* HTML Search: HTML tags are displayed as a part of object name
+* HTML Search: search snipets should not be folded
+* HTML Search: Minor errors are emitted on fetching search snipets
+* HTML Search: The markers for header links are shown in the search result
+* #10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.
+* #6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
+* #10566: HTML Theme: Fix enable_search_shortcuts does not work
+* #8686: LaTeX: Text can fall out of code-block at end of page and leave artifact
+ on next page
+* #10633: LaTeX: user injected ``\color`` commands in topic or admonition boxes may
+ cause color leaks in PDF due to upstream `framed.sty <https://ctan.org/pkg/framed>`_
+ bug
+* #10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
+ diffs using Pygments style ``'manni'``) inherit thickness of code-block frame
+* #10647: LaTeX: Only one ``\label`` is generated for ``desc_signature`` node
+ even if it has multiple node IDs
+* #10579: i18n: UnboundLocalError is raised on translating raw directive
+* #9577, #10088: py domain: Fix warning for duplicate Python references when
+ using ``:any:`` and autodoc.
+* #10548: HTML Search: fix minor summary issues.
+
+Release 5.0.2 (released Jun 17, 2022)
+=====================================
+
+Features added
+--------------
+
+* #10523: HTML Theme: Expose the Docutils's version info tuple as a template
+ variable, ``docutils_version_info``. Patch by Adam Turner.
+
+Bugs fixed
+----------
+
+* #10538: autodoc: Inherited class attribute having docstring is documented even
+ if :confval:`autodoc_inherit_docstring` is disabled
+* #10509: autosummary: autosummary fails with a shared library
+* #10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
+* #10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.
+ Patch by Adam Turner.
+* #10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.
+
+Release 5.0.1 (released Jun 03, 2022)
+=====================================
+
+Bugs fixed
+----------
+
+* #10498: gettext: TypeError is raised when sorting warning messages if a node
+ has no line number. Patch by Adam Turner.
+* #10493: HTML Theme: :dudir:`topic` directive is rendered incorrectly with
+ Docutils 0.18. Patch by Adam Turner.
+* #10495: IndexError is raised for a :rst:role:`kbd` role having a separator.
+ Patch by Adam Turner.
+
+Release 5.0.0 (released May 30, 2022)
+=====================================
+
+Dependencies
+------------
+
+5.0.0 b1
+
+* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.
+
+.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26
+
+Incompatible changes
+--------------------
+
+5.0.0 b1
+
+* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises
+ ``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import
+ target object. Please handle the exception if your extension uses the
+ function to import Python object. As a workaround, you can disable the
+ behavior via ``grouped_exception=False`` keyword argument until v7.0.
+* #9962: texinfo: Customizing styles of emphasized text via ``@definfoenclose``
+ command was not supported because the command was deprecated since texinfo 6.8
+* #2068: :confval:`intersphinx_disabled_reftypes` has changed default value
+ from an empty list to ``['std:doc']`` as avoid too surprising silent
+ intersphinx resolutions.
+ To migrate: either add an explicit inventory name to the references
+ intersphinx should resolve, or explicitly set the value of this configuration
+ variable to an empty list.
+* #10197: html theme: Reduce ``body_min_width`` setting in basic theme to 360px
+* #9999: LaTeX: separate terms from their definitions by a CR (refs: #9985)
+* #10062: Change the default language to ``'en'`` if any language is not set in
+ ``conf.py``
+
+5.0.0 final
+
+* #10474: :confval:`language` does not accept ``None`` as it value. The default
+ value of ``language`` becomes to ``'en'`` now.
+ Patch by Adam Turner and Takeshi KOMIYA.
+
+Deprecated
+----------
+
+5.0.0 b1
+
+* #10028: jQuery and underscore.js will 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 or use the mitigation below.
+
+ 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``:
+
+ .. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v5.3.0/sphinx/themes/basic/static
+ .. code-block:: html+jinja
+
+ {%- block scripts %}
+ <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>
+ <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>
+ {{ super() }}
+ {%- endblock %}
+
+ Patch by Adam Turner.
+* setuptools integration. The ``build_sphinx`` sub-command for setup.py is
+ marked as deprecated to follow the policy of setuptools team.
+* The ``locale`` argument of ``sphinx.util.i18n:babel_format_date()`` becomes
+ required
+* The ``language`` argument of ``sphinx.util.i18n:format_date()`` becomes
+ required
+* ``sphinx.builders.html.html5_ready``
+* ``sphinx.io.read_doc()``
+* ``sphinx.util.docutils.__version_info__``
+* ``sphinx.util.docutils.is_html5_writer_available()``
+* ``sphinx.writers.latex.LaTeXWriter.docclasses``
+
+Features added
+--------------
+
+5.0.0 b1
+
+* #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is
+ changed to ``'smart'``. It will suppress the leading module names of
+ typehints (ex. ``io.StringIO`` -> ``StringIO``).
+* #8417: autodoc: ``:inherited-members:`` option now takes multiple classes. It
+ allows to suppress inherited members of several classes on the module at once
+ by specifying the option to :rst:dir:`automodule` directive
+* #9792: autodoc: Add new option for ``autodoc_typehints_description_target`` to
+ include undocumented return values but not undocumented parameters.
+* #10285: autodoc: singledispatch functions having typehints are not documented
+* autodoc: :confval:`autodoc_typehints_format` now also applies to attributes,
+ data, properties, and type variable bounds.
+* #10258: autosummary: Recognize a documented attribute of a module as
+ non-imported
+* #10028: Removed internal usages of JavaScript frameworks (jQuery and
+ underscore.js) and modernised ``doctools.js`` and ``searchtools.js`` to
+ EMCAScript 2018. Patch by Adam Turner.
+* #10302: C++, add support for conditional expressions (``?:``).
+* #5157, #10251: Inline code is able to be highlighted via :dudir:`role`
+ directive
+* #10337: Make sphinx-build faster by caching Publisher object during build.
+ Patch by Adam Turner.
+
+Bugs fixed
+----------
+
+5.0.0 b1
+
+* #10200: apidoc: Duplicated submodules are shown for modules having both .pyx
+ and .so files. Patch by Adam Turner and Takeshi KOMIYA.
+* #10279: autodoc: Default values for keyword only arguments in overloaded
+ functions are rendered as a string literal
+* #10280: autodoc: :confval:`autodoc_docstring_signature` unexpectedly generates
+ return value typehint for constructors if docstring has multiple signatures
+* #10266: autodoc: :confval:`autodoc_preserve_defaults` does not work for
+ mixture of keyword only arguments with/without defaults
+* #10310: autodoc: class methods are not documented when decorated with mocked
+ function
+* #10305: autodoc: Failed to extract optional forward-ref'ed typehints correctly
+ via :confval:`autodoc_type_aliases`
+* #10421: autodoc: :confval:`autodoc_preserve_defaults` doesn't work on class
+ methods
+* #10214: html: invalid language tag was generated if :confval:`language`
+ contains a country code (ex. zh_CN)
+* #9974: html: Updated jQuery version from 3.5.1 to 3.6.0
+* #10236: html search: objects are duplicated in search result
+* #9962: texinfo: Deprecation message for ``@definfoenclose`` command on
+ bulding texinfo document
+* #10000: LaTeX: glossary terms with common definition are rendered with
+ too much vertical whitespace
+* #10188: LaTeX: alternating multiply referred footnotes produce a ``?`` in
+ pdf output
+* #10363: LaTeX: make ``'howto'`` title page rule use ``\linewidth`` for
+ compatibility with usage of a ``twocolumn`` class option
+* #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not
+ work with ``:dedent:`` option
+
+5.0.0 final
+
+* #9575: autodoc: The annotation of return value should not be shown when
+ ``autodoc_typehints="description"``
+* #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
+ ``autodoc_typehints="description"``
+* #8180: autodoc: Docstring metadata ignored for attributes
+* #10443: epub: EPUB builder can't detect the mimetype of .webp file
+* #10104: gettext: Duplicated locations are shown if 3rd party extension does
+ not provide correct information
+* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two
+ or more meta-field
+* #9096: sphinx-build: the value of progress bar for paralle build is wrong
+* #10110: sphinx-build: exit code is not changed when error is raised on
+ builder-finished event
+
+Release 4.5.0 (released Mar 28, 2022)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #10112: extlinks: Disable hardcoded links detector by default
+* #9993, #10177: std domain: Disallow to refer an inline target via
+ :rst:role:`ref` role
+
+Deprecated
+----------
+
+* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
+
+Features added
+--------------
+
+* #10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
+* #10234: autosummary: Add "autosummary" CSS class to summary tables
+* #10125: extlinks: Improve suggestion message for a reference having title
+* #10112: extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
+ hardcoded links detector feature
+* #9494, #9456: html search: Add a config variable
+ :confval:`html_show_search_summary` to enable/disable the search summaries
+* #9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:`/` as
+ a Quick search shortcut and :kbd:`Esc` shortcut that
+ removes search highlighting.
+* #10107: i18n: Allow to suppress translation warnings by adding ``#noqa``
+ comment to the tail of each translation message
+* #10252: C++, support attributes on classes, unions, and enums.
+* #10253: :rst:role:`pep` role now generates URLs based on `peps.python.org
+ <https://peps.python.org>`_
+
+Bugs fixed
+----------
+
+* #9876: autodoc: Failed to document an imported class that is built from native
+ binary module
+* #10133: autodoc: Crashed when mocked module is used for type annotation
+* #10146: autodoc: :confval:`autodoc_default_options` does not support
+ ``no-value`` option
+* #9971: autodoc: TypeError is raised when the target object is annotated by
+ unhashable object
+* #10205: extlinks: Failed to compile regexp on checking hardcoded links
+* #10277: html search: Could not search short words (ex. "use")
+* #9529: LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
+ multiple times was rendered to a question mark
+* #9924: LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
+ spacing in Latexpdf
+* #10158: LaTeX: excessive whitespace since v4.4.0 for undocumented
+ variables/structure members
+* #10175: LaTeX: named footnote reference is linked to an incorrect footnote if
+ the name is also used in the different document
+* #10269: manpage: Failed to resolve the title of :rst:role:`ref` cross references
+* #10179: i18n: suppress "rST localization" warning
+* #10118: imgconverter: Unnecessary availablity check is called for remote URIs
+* #10181: napoleon: attributes are displayed like class attributes for google
+ style docstrings when :confval:`napoleon_use_ivar` is enabled
+* #10122: sphinx-build: make.bat does not check the installation of sphinx-build
+ command before showing help
+
+Release 4.4.0 (released Jan 17, 2022)
+=====================================
+
+Dependencies
+------------
+
+* #10007: Use ``importlib_metadata`` for python-3.9 or older
+* #10007: Drop ``setuptools``
+
+Features added
+--------------
+
+* #9075: autodoc: Add a config variable :confval:`autodoc_typehints_format`
+ to suppress the leading module names of typehints of function signatures (ex.
+ ``io.StringIO`` -> ``StringIO``)
+* #9831: Autosummary now documents only the members specified in a module's
+ ``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to
+ ``False``. The default behaviour is unchanged. Autogen also now supports
+ this behavior with the ``--respect-module-all`` switch.
+* #9555: autosummary: Improve error messages on failure to load target object
+* #9800: extlinks: Emit warning if a hardcoded link is replaceable
+ by an extlink, suggesting a replacement.
+* #9961: html: Support nested <kbd> HTML elements in other HTML builders
+* #10013: html: Allow to change the loading method of JS via ``loading_method``
+ parameter for :meth:`.Sphinx.add_js_file()`
+* #9551: html search: "Hide Search Matches" link removes "highlight" parameter
+ from URL
+* #9815: html theme: Wrap sidebar components in div to allow customizing their
+ layout via CSS
+* #9827: i18n: Sort items in glossary by translated terms
+* #9899: py domain: Allows to specify cross-reference specifier (``.`` and
+ ``~``) as ``:type:`` option
+* #9894: linkcheck: add option ``linkcheck_exclude_documents`` to disable link
+ checking in matched documents.
+* #9793: sphinx-build: Allow to use the parallel build feature in macOS on macOS
+ and Python3.8+
+* #10055: sphinx-build: Create directories when ``-w`` option given
+* #9993: std domain: Allow to refer an inline target (ex. ``_`target name```)
+ via :rst:role:`ref` role
+* #9981: std domain: Strip value part of the option directive from general index
+* #9391: texinfo: improve variable in ``samp`` role
+* #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross
+ references for readability with standalone readers
+* #9822 (and #9062), add new Intersphinx role :rst:role:`external` for explict
+ lookup in the external projects, without resolving to the local project.
+
+Bugs fixed
+----------
+
+* #9866: autodoc: doccomment for the imported class was ignored
+* #9883: autodoc: doccomment for the alias to mocked object was ignored
+* #9908: autodoc: debug message is shown on building document using NewTypes
+ with Python 3.10
+* #9968: autodoc: instance variables are not shown if __init__ method has
+ position-only-arguments
+* #9194: autodoc: types under the "typing" module are not hyperlinked
+* #10009: autodoc: Crashes if target object raises an error on getting docstring
+* #10058: autosummary: Imported members are not shown when
+ ``autodoc_class_signature = 'separated'``
+* #9947: i18n: topic directive having a bullet list can't be translatable
+* #9878: mathjax: MathJax configuration is placed after loading MathJax itself
+* #9932: napoleon: empty "returns" section is generated even if no description
+* #9857: Generated RFC links use outdated base url
+* #9909: HTML, prevent line-wrapping in literal text.
+* #10061: html theme: Configuration values added by themes are not be able to
+ override from conf.py
+* #10073: imgconverter: Unnecessary availablity check is called for "data" URIs
+* #9925: LaTeX: prohibit also with ``'xelatex'`` line splitting at dashes of
+ inline and parsed literals
+* #9944: LaTeX: extra vertical whitespace for some nested declarations
+* #9940: LaTeX: Multi-function declaration in Python domain has cramped
+ vertical spacing in latexpdf output
+* #10015: py domain: types under the "typing" module are not hyperlinked defined
+ at info-field-list
+* #9390: texinfo: Do not emit labels inside footnotes
+* #9413: xml: Invalid XML was generated when cross referencing python objects
+* #9979: Error level messages were displayed as warning messages
+* #10057: Failed to scan documents if the project is placed onto the root
+ directory
+* #9636: code-block: ``:dedent:`` without argument did strip newlines
+
+Release 4.3.2 (released Dec 19, 2021)
+=====================================
+
+Bugs fixed
+----------
+
+* #9917: C and C++, parse fundamental types no matter the order of simple type
+ specifiers.
+
+Release 4.3.1 (released Nov 28, 2021)
+=====================================
+
+Features added
+--------------
+
+* #9864: mathjax: Support chnaging the loading method of MathJax to "defer" via
+ :confval:`mathjax_options`
+
+Bugs fixed
+----------
+
+* #9838: autodoc: AttributeError is raised on building document for functions
+ decorated by functools.lru_cache
+* #9879: autodoc: AttributeError is raised on building document for an object
+ having invalid __doc__ attribute
+* #9844: autodoc: Failed to process a function wrapped with functools.partial if
+ :confval:`autodoc_preserve_defaults` enabled
+* #9872: html: Class namespace collision between autodoc signatures and
+ docutils-0.17
+* #9868: imgmath: Crashed if the dvisvgm command failed to convert equation
+* #9864: mathjax: Failed to render equations via MathJax v2. The loading method
+ of MathJax is back to "async" method again
+
+Release 4.3.0 (released Nov 11, 2021)
+=====================================
+
+Dependencies
+------------
+
+* Support Python 3.10
+
+Incompatible changes
+--------------------
+
+* #9649: ``searchindex.js``: the embedded data has changed format to allow
+ objects with the same name in different domains.
+* #9672: The rendering of Python domain declarations is implemented
+ with more docutils nodes to allow better CSS styling.
+ It may break existing styling.
+* #9672: the signature of
+ ``domains.python.PyObject.get_signature_prefix`` has changed to
+ return a list of nodes instead of a plain string.
+* #9695: ``domains.js.JSObject.display_prefix`` has been changed into a method
+ ``get_display_prefix`` which now returns a list of nodes
+ instead of a plain string.
+* #9695: The rendering of Javascript domain declarations is implemented
+ with more docutils nodes to allow better CSS styling.
+ It may break existing styling.
+* #9450: mathjax: Load MathJax via "defer" strategy
+
+Deprecated
+----------
+
+* ``sphinx.ext.autodoc.AttributeDocumenter._datadescriptor``
+* ``sphinx.writers.html.HTMLTranslator._fieldlist_row_index``
+* ``sphinx.writers.html.HTMLTranslator._table_row_index``
+* ``sphinx.writers.html5.HTML5Translator._fieldlist_row_index``
+* ``sphinx.writers.html5.HTML5Translator._table_row_index``
+
+Features added
+--------------
+
+* #9639: autodoc: Support asynchronous generator functions
+* #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a
+ base class
+* #9691: C, added new info-field ``retval``
+ for :rst:dir:`c:function` and :rst:dir:`c:macro`.
+* C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.
+* #9618: i18n: Add :confval:`gettext_allow_fuzzy_translations` to allow "fuzzy"
+ messages for translation
+* #9672: More CSS classes on Python domain descriptions
+* #9695: More CSS classes on Javascript domain descriptions
+* #9683: Revert the removal of ``add_stylesheet()`` API. It will be kept until
+ the Sphinx 6.0 release
+* #2068, add :confval:`intersphinx_disabled_reftypes` for disabling
+ interphinx resolution of cross-references that do not have an explicit
+ inventory specification. Specific types of cross-references can be disabled,
+ e.g., ``std:doc`` or all cross-references in a specific domain,
+ e.g., ``std:*``.
+* #9623: Allow to suppress "toctree contains reference to excluded document"
+ warnings using :confval:`suppress_warnings`
+
+Bugs fixed
+----------
+
+* #9630: autodoc: Failed to build cross references if :confval:`primary_domain`
+ is not 'py'
+* #9644: autodoc: Crashed on getting source info from problematic object
+* #9655: autodoc: mocked object having doc comment is warned unexpectedly
+* #9651: autodoc: return type field is not generated even if
+ :confval:`autodoc_typehints_description_target` is set to "documented" when
+ its info-field-list contains ``:returns:`` field
+* #9657: autodoc: The base class for a subclass of mocked object is incorrect
+* #9607: autodoc: Incorrect base class detection for the subclasses of the
+ generic class
+* #9755: autodoc: memory addresses are shown for aliases
+* #9752: autodoc: Failed to detect type annotation for slots attribute
+* #9756: autodoc: Crashed if classmethod does not have __func__ attribute
+* #9757: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
+ overridden classmethods
+* #9781: autodoc: :confval:`autodoc_preserve_defaults` does not support
+ hexadecimal numeric
+* #9630: autosummary: Failed to build summary table if :confval:`primary_domain`
+ is not 'py'
+* #9670: html: Fix download file with special characters
+* #9710: html: Wrong styles for even/odd rows in nested tables
+* #9763: html: parameter name and its type annotation are not separated in HTML
+* #9649: HTML search: when objects have the same name but in different domains,
+ return all of them as result instead of just one.
+* #7634: intersphinx: references on the file in sub directory are broken
+* #9737: LaTeX: hlist is rendered as a list containing "aggedright" text
+* #9678: linkcheck: file extension was shown twice in warnings
+* #9697: py domain: An index entry with parens was registered for ``py:method``
+ directive with ``:property:`` option
+* #9775: py domain: Literal typehint was converted to a cross reference when
+ :confval:`autodoc_typehints`\ ``='description'``
+* #9708: needs_extension failed to check double-digit version correctly
+* #9688: Fix Sphinx patched :dudir:`code` does not recognize ``:class:`` option
+* #9733: Fix for logging handler flushing warnings in the middle of the docs
+ build
+* #9656: Fix warnings without subtype being incorrectly suppressed
+* Intersphinx, for unresolved references with an explicit inventory,
+ e.g., ``proj:myFunc``, leave the inventory prefix in the unresolved text.
+
+Release 4.2.0 (released Sep 12, 2021)
+=====================================
+
+Features added
+--------------
+
+* #9445: autodoc: Support class properties
+* #9479: autodoc: Emit a warning if target is a mocked object
+* #9560: autodoc: Allow to refer NewType instances with module name in Python
+ 3.10 or above
+* #9447: html theme: Expose the version of Sphinx in the form of tuple as a
+ template variable ``sphinx_version_tuple``
+* #9594: manpage: Suppress the title of man page if description is empty
+* #9445: py domain: :rst:dir:`py:property` directive supports ``:classmethod:``
+ option to describe the class property
+* #9524: test: SphinxTestApp can take ``builddir`` as an argument
+* #9535: C and C++, support more fundamental types, including GNU extensions.
+
+Bugs fixed
+----------
+
+* #9608: apidoc: apidoc does not generate a module definition for implicit
+ namespace package
+* #9504: autodoc: generate incorrect reference to the parent class if the target
+ class inherites the class having ``_name`` attribute
+* #9537, #9589: autodoc: Some objects under ``typing`` module are not displayed
+ well with the HEAD of 3.10
+* #9487: autodoc: typehint for cached_property is not shown
+* #9509: autodoc: AttributeError is raised on failed resolving typehints
+* #9518: autodoc: autodoc_docstring_signature does not effect to ``__init__()``
+ and ``__new__()``
+* #9522: autodoc: PEP 585 style typehints having arguments (ex. ``list[int]``)
+ are not displayed well
+* #9481: autosummary: some warnings contain non-existing filenames
+* #9568: autosummary: summarise overlined sectioned headings correctly
+* #9600: autosummary: Type annotations which contain commas in autosummary table
+ are not removed completely
+* #9481: c domain: some warnings contain non-existing filenames
+* #9481: cpp domain: some warnings contain non-existing filenames
+* #9456: html search: abbreation marks are inserted to the search result if
+ failed to fetch the content of the page
+* #9617: html search: The JS requirement warning is shown if browser is slow
+* #9267: html theme: CSS and JS files added by theme were loaded twice
+* #9585: py domain: ``:type:`` option for :rst:dir:`py:property` directive does
+ not create a hyperlink
+* #9576: py domain: Literal typehint was converted to a cross reference
+* #9535 comment: C++, fix parsing of defaulted function parameters that are
+ function pointers.
+* #9564: smartquotes: don't adjust typography for text with
+ language-highlighted ``:code:`` role.
+* #9512: sphinx-build: crashed with the HEAD of Python 3.10
+
+Release 4.1.2 (released Jul 27, 2021)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #9435: linkcheck: Disable checking automatically generated anchors on
+ github.com (ex. anchors in reST/Markdown documents)
+
+Bugs fixed
+----------
+
+* #9489: autodoc: Custom types using ``typing.NewType`` are not displayed well
+ with the HEAD of 3.10
+* #9490: autodoc: Some objects under ``typing`` module are not displayed well
+ with the HEAD of 3.10
+* #9436, #9471: autodoc: crashed if ``autodoc_class_signature = "separated"``
+* #9456: html search: html_copy_source can't control the search summaries
+* #9500: LaTeX: Failed to build Japanese document on Windows
+* #9435: linkcheck: Failed to check anchors in github.com
+
+Release 4.1.1 (released Jul 15, 2021)
+=====================================
+
+Dependencies
+------------
+
+* #9434: sphinxcontrib-htmlhelp-2.0.0 or above
+* #9434: sphinxcontrib-serializinghtml-1.1.5 or above
+
+Bugs fixed
+----------
+
+* #9438: html: HTML logo or Favicon specified as file not being found on output
+
+Release 4.1.0 (released Jul 12, 2021)
+=====================================
+
+Dependencies
+------------
+
+* Support jinja2-3.0
+
+Deprecated
+----------
+
+* The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes
+ required
+* ``sphinx.application.Sphinx.html_theme``
+* ``sphinx.ext.autosummary._app``
+* ``sphinx.util.docstrings.extract_metadata()``
+
+Features added
+--------------
+
+* #8107: autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass`
+ directive to control the content of the specific class like
+ :confval:`autoclass_content`
+* #8588: autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It
+ allows you to define an alias for a class with module name like
+ ``foo.bar.BazClass``
+* #9175: autodoc: Special member is not documented in the module
+* #9195: autodoc: The arguments of ``typing.Literal`` are wrongly rendered
+* #9185: autodoc: :confval:`autodoc_typehints` allows ``'both'`` setting to
+ allow typehints to be included both in the signature and description
+* #4257: autodoc: Add :confval:`autodoc_class_signature` to separate the class
+ entry and the definition of ``__init__()`` method
+* #8061, #9218: autodoc: Support variable comment for alias classes
+* #3014: autodoc: Add :event:`autodoc-process-bases` to modify the base classes
+ of the class definitions
+* #9272: autodoc: Render enum values for the default argument value better
+* #9384: autodoc: ``autodoc_typehints='none'`` now erases typehints for
+ variables, attributes and properties
+* #3257: autosummary: Support instance attributes for classes
+* #9358: html: Add "heading" role to the toctree items
+* #9225: html: Add span tag to the return typehint of method/function
+* #9129: html search: Show search summaries when html_copy_source = False
+* #9307: html search: Prevent corrections and completions in search field
+* #9120: html theme: Eliminate prompt characters of code-block from copyable
+ text
+* #9176: i18n: Emit a debug message if message catalog file not found under
+ :confval:`locale_dirs`
+* #9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
+* #9016: linkcheck: Support checking anchors on github.com
+* #9016: linkcheck: Add a new event :event:`linkcheck-process-uri` to modify
+ URIs before checking hyperlinks
+* #6525: linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark
+ hyperlinks that are redirected to expected URLs as "working"
+* #1874: py domain: Support union types using ``|`` in info-field-list
+* #9268: py domain: :confval:`python_use_unqualified_type_names` supports type
+ field in info-field-list
+* #9097: Optimize the parallel build
+* #9131: Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using
+ regular expressions
+* #9174: Add ``Sphinx.set_html_assets_policy`` to tell extensions to include
+ HTML assets in all the pages. Extensions can check this via
+ ``Sphinx.registry.html_assets_policy``
+* C++, add support for
+
+ - ``inline`` variables,
+ - ``consteval`` functions,
+ - ``constinit`` variables,
+ - ``char8_t``,
+ - ``explicit(<constant expression>)`` specifier,
+ - digit separators in literals, and
+ - constraints in placeholder type specifiers, aka. adjective syntax
+ (e.g., ``Sortable auto &v``).
+
+* C, add support for digit separators in literals.
+* #9166: LaTeX: support containers in LaTeX output
+
+
+Bugs fixed
+----------
+
+* #8872: autodoc: stacked singledispatches are wrongly rendered
+* #8597: autodoc: a docsting having metadata only should be treated as
+ undocumented
+* #9185: autodoc: typehints for overloaded functions and methods are inaccurate
+* #9250: autodoc: The inherited method not having docstring is wrongly parsed
+* #9283: autodoc: autoattribute directive failed to generate document for an
+ attribute not having any comment
+* #9364: autodoc: single element tuple on the default argument value is wrongly
+ rendered
+* #9362: autodoc: AttributeError is raised on processing a subclass of Tuple[()]
+* #9404: autodoc: TypeError is raised on processing dict-like object (not a
+ class) via autoclass directive
+* #9317: html: Pushing left key causes visiting the next page at the first page
+* #9381: html: URL for html_favicon and html_log does not work
+* #9270: html theme : pyramid theme generates incorrect logo links
+* #9217: manpage: The name of manpage directory that is generated by
+ :confval:`man_make_section_directory` is not correct
+* #9350: manpage: Fix font isn't reset after keyword at the top of samp role
+* #9306: Linkcheck reports broken link when remote server closes the connection
+ on HEAD request
+* #9280: py domain: "exceptions" module is not displayed
+* #9418: py domain: a Callable annotation with no parameters
+ (e.g. ``Callable[[], None])`` will be rendered with a bracket missing
+ (``Callable[], None]``)
+* #9319: quickstart: Make sphinx-quickstart exit when conf.py already exists
+* #9387: xml: XML Builder ignores custom visitors
+* #9224: ``:param:`` and ``:type:`` fields does not support a type containing
+ whitespace (ex. ``Dict[str, str]``)
+* #8945: when transforming typed fields, call the specified role instead of
+ making an single xref. For C and C++, use the ``expr`` role for typed fields.
+
+Release 4.0.3 (released Jul 05, 2021)
+=====================================
+
+Features added
+--------------
+
+* C, add C23 keywords ``_Decimal32``, ``_Decimal64``, and ``_Decimal128``.
+* #9354: C, add :confval:`c_extra_keywords` to allow user-defined keywords
+ during parsing.
+* Revert the removal of ``sphinx.util:force_decode()`` to become some 3rd party
+ extensions available again during 5.0
+
+Bugs fixed
+----------
+
+* #9330: changeset domain: :rst:dir:`versionchanged` with contents being a list
+ will cause error during pdf build
+* #9313: LaTeX: complex table with merged cells broken since 4.0
+* #9305: LaTeX: backslash may cause Improper discretionary list pdf build error
+ with Japanese engines
+* #9354: C, remove special macro names from the keyword list.
+ See also :confval:`c_extra_keywords`.
+* #9322: KeyError is raised on PropagateDescDomain transform
+
+Release 4.0.2 (released May 20, 2021)
+=====================================
+
+Dependencies
+------------
+
+* #9216: Support jinja2-3.0
+
+Incompatible changes
+--------------------
+
+* #9222: Update Underscore.js to 1.13.1
+* #9217: manpage: Stop creating a section directory on build manpage by default
+ (see :confval:`man_make_section_directory`)
+
+Bugs fixed
+----------
+
+* #9210: viewcode: crashed if non importable modules found on parallel build
+* #9240: Unknown node error for pending_xref_condition is raised if an extension
+ that does not support the node installs a missing-reference handler
+
+Release 4.0.1 (released May 11, 2021)
+=====================================
+
+Bugs fixed
+----------
+
+* #9189: autodoc: crashed when ValueError is raised on generating signature
+ from a property of the class
+* #9188: autosummary: warning is emitted if list value is set to
+ autosummary_generate
+* #8380: html search: tags for search result are broken
+* #9198: i18n: Babel emits errors when running compile_catalog
+* #9205: py domain: The :canonical: option causes "more than one target for
+ cross-reference" warning
+* #9201: websupport: UndefinedError is raised: 'css_tag' is undefined
+
+Release 4.0.0 (released May 09, 2021)
+=====================================
+
+Dependencies
+------------
+
+4.0.0b1
+
+* Drop python 3.5 support
+* Drop docutils 0.12 and 0.13 support
+* LaTeX: add ``tex-gyre`` font dependency
+
+4.0.0b2
+
+* Support docutils-0.17. Please notice it changes the output of HTML builder.
+ Some themes do not support it, and you need to update your custom CSS to
+ upgrade it.
+
+Incompatible changes
+--------------------
+
+4.0.0b1
+
+* #8539: autodoc: info-field-list is generated into the class description when
+ :confval:`autodoc_typehints`\ ``='description'`` and
+ :confval:`autoclass_content`\ ``='class'`` set
+* #8898: extlinks: "%s" becomes required keyword in the link caption string
+* domain: The ``Index`` class becomes subclasses of ``abc.ABC`` to indicate
+ methods that must be overridden in the concrete classes
+* #4826: py domain: The structure of python objects is changed. A boolean value
+ is added to indicate that the python object is canonical one
+* #7425: MathJax: The MathJax was changed from 2 to 3. Users using a custom
+ MathJax configuration may have to set the old MathJax path or update their
+ configuration for version 3. See :mod:`sphinx.ext.mathjax`.
+* #7784: i18n: The msgid for alt text of image is changed
+* #5560: napoleon: :confval:`napoleon_use_param` also affect "other parameters"
+ section
+* #7996: manpage: Make a section directory on build manpage by default (see
+ :confval:`man_make_section_directory`)
+* #7849: html: Change the default setting of
+ :confval:`html_codeblock_linenos_style` to ``'inline'``
+* #8380: html search: search results are wrapped with ``<p>`` instead of
+ ``<div>``
+* html theme: Move a script tag for documentation_options.js in
+ basic/layout.html to ``script_files`` variable
+* html theme: Move CSS tags in basic/layout.html to ``css_files`` variable
+* #8915: html theme: Emit a warning for sphinx_rtd_theme-0.2.4 or older
+* #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese
+ documents
+* #5977: py domain: ``:var:``, ``:cvar:`` and ``:ivar:`` fields do not create
+ cross-references
+* #4550: The ``align`` attribute of ``figure`` and ``table`` nodes becomes
+ ``None`` by default instead of ``'default'``
+* #8769: LaTeX refactoring: split sphinx.sty into multiple files and rename
+ some auxiliary files created in ``latex`` build output repertory
+* #8937: Use explicit title instead of <no title>
+* #8487: The :file: option for csv-table directive now recognizes an absolute
+ path as a relative path from source directory
+
+4.0.0b2
+
+* #9023: Change the CSS classes on :rst:role:`cpp:expr` and
+ :rst:role:`cpp:texpr`.
+
+Deprecated
+----------
+
+* :confval:`html_codeblock_linenos_style`
+* ``favicon`` and ``logo`` variable in HTML templates
+* ``sphinx.directives.patches.CSVTable``
+* ``sphinx.directives.patches.ListTable``
+* ``sphinx.directives.patches.RSTTable``
+* ``sphinx.ext.autodoc.directive.DocumenterBridge.filename_set``
+* ``sphinx.ext.autodoc.directive.DocumenterBridge.warn()``
+* ``sphinx.registry.SphinxComponentRegistry.get_source_input()``
+* ``sphinx.registry.SphinxComponentRegistry.source_inputs``
+* ``sphinx.transforms.FigureAligner``
+* ``sphinx.util.pycompat.convert_with_2to3()``
+* ``sphinx.util.pycompat.execfile_()``
+* ``sphinx.util.smartypants``
+* ``sphinx.util.typing.DirectiveOption``
+
+Features added
+--------------
+
+4.0.0b1
+
+* #8924: autodoc: Support ``bound`` argument for TypeVar
+* #7383: autodoc: Support typehints for properties
+* #5603: autodoc: Allow to refer to a python class using its canonical name
+ when the class has two different names; a canonical name and an alias name
+* #8539: autodoc: Add :confval:`autodoc_typehints_description_target` to control
+ the behavior of ``autodoc_typehints=description``
+* #8841: autodoc: :confval:`autodoc_docstring_signature` will continue to look
+ for multiple signature lines without backslash character
+* #7549: autosummary: Enable :confval:`autosummary_generate` by default
+* #8898: extlinks: Allow %s in link caption string
+* #4826: py domain: Add ``:canonical:`` option to python directives to describe
+ the location where the object is defined
+* #7199: py domain: Add :confval:`python_use_unqualified_type_names` to suppress
+ the module name of the python reference if it can be resolved (experimental)
+* #7068: py domain: Add :rst:dir:`py:property` directive to describe a property
+* #7784: i18n: The alt text for image is translated by default (without
+ :confval:`gettext_additional_targets` setting)
+* #2018: html: :confval:`html_favicon` and :confval:`html_logo` now accept URL
+ for the image
+* #8070: html search: Support searching for 2characters word
+* #9036: html theme: Allow to inherite the search page
+* #8938: imgconverter: Show the error of the command availability check
+* #7830: Add debug logs for change detection of sources and templates
+* #8201: Emit a warning if toctree contains duplicated entries
+* #8326: ``master_doc`` is now renamed to :confval:`root_doc`
+* #8942: C++, add support for the C++20 spaceship operator, ``<=>``.
+* #7199: A new node, ``sphinx.addnodes.pending_xref_condition`` has been added.
+ It can be used to choose appropriate content of the reference by conditions.
+
+4.0.0b2
+
+* #8818: autodoc: Super class having ``Any`` arguments causes nit-picky warning
+* #9095: autodoc: TypeError is raised on processing broken metaclass
+* #9110: autodoc: metadata of GenericAlias is not rendered as a reference in
+ py37+
+* #9098: html: copy-range protection for doctests doesn't work in Safari
+* #9103: LaTeX: imgconverter: conversion runs even if not needed
+* #8127: py domain: Ellipsis in info-field-list causes nit-picky warning
+* #9121: py domain: duplicated warning is emitted when both canonical and its
+ alias objects are defined on the document
+* #9023: More CSS classes on domain descriptions, see :ref:`nodes` for details.
+* #8195: mathjax: Rename :confval:`mathjax_config` to
+ :confval:`mathjax2_config` and add :confval:`mathjax3_config`
+
+Bugs fixed
+----------
+
+4.0.0b1
+
+* #8917: autodoc: Raises a warning if function has wrong __globals__ value
+* #8415: autodoc: a TypeVar imported from other module is not resolved (in
+ Python 3.7 or above)
+* #8992: autodoc: Failed to resolve types.TracebackType type annotation
+* #8905: html: html_add_permalinks=None and html_add_permalinks="" are ignored
+* #8380: html search: Paragraphs in search results are not identified as ``<p>``
+* #8915: html theme: The translation of sphinx_rtd_theme does not work
+* #8342: Emit a warning if a unknown domain is given for directive or role (ex.
+ ``:unknown:doc:``)
+* #7241: LaTeX: No wrapping for ``cpp:enumerator``
+* #8711: LaTeX: backticks in code-blocks trigger latexpdf build warning (and font
+ change) with late TeXLive 2019
+* #8253: LaTeX: Figures with no size defined get overscaled (compared to images
+ with size explicitly set in pixels) (fixed for ``'pdflatex'/'lualatex'`` only)
+* #8881: LaTeX: The depth of bookmarks panel in PDF is not enough for navigation
+* #8874: LaTeX: the fix to two minor Pygments LaTeXFormatter output issues ignore
+ Pygments style
+* #8925: LaTeX: 3.5.0 ``verbatimmaxunderfull`` setting does not work as
+ expected
+* #8980: LaTeX: missing line break in ``\pysigline``
+* #8995: LaTeX: legacy ``\pysiglinewithargsret`` does not compute correctly
+ available horizontal space and should use a ragged right style
+* #9009: LaTeX: "release" value with underscore leads to invalid LaTeX
+* #8911: C++: remove the longest matching prefix in
+ :confval:`cpp_index_common_prefix` instead of the first that matches.
+* C, properly reject function declarations when a keyword is used
+ as parameter name.
+* #8933: viewcode: Failed to create back-links on parallel build
+* #8960: C and C++, fix rendering of (member) function pointer types in
+ function parameter lists.
+* C++, fix linking of names in array declarators, pointer to member
+ (function) declarators, and in the argument to ``sizeof...``.
+* C, fix linking of names in array declarators.
+
+4.0.0b2
+
+* C, C++, fix ``KeyError`` when an ``alias`` directive is the first C/C++
+ directive in a file with another C/C++ directive later.
+
+4.0.0b3
+
+* #9167: html: Failed to add CSS files to the specific page
+
+Release 3.5.5 (in development)
+==============================
+
+Release 3.5.4 (released Apr 11, 2021)
+=====================================
+
+Dependencies
+------------
+
+* #9071: Restrict docutils to 0.16
+
+Bugs fixed
+----------
+
+* #9078: autodoc: Async staticmethods and classmethods are considered as non
+ async coroutine-functions with Python3.10
+* #8870, #9001, #9051: html theme: The style are not applied with docutils-0.17
+
+ - toctree captions
+ - The content of ``sidebar`` directive
+ - figures
+
+Release 3.5.3 (released Mar 20, 2021)
+=====================================
+
+Features added
+--------------
+
+* #8959: using UNIX path separator in image directive confuses Sphinx on Windows
+
+Release 3.5.2 (released Mar 06, 2021)
+=====================================
+
+Bugs fixed
+----------
+
+* #8943: i18n: Crashed by broken translation messages in ES, EL and HR
+* #8936: LaTeX: A custom LaTeX builder fails with unknown node error
+* #8952: Exceptions raised in a Directive cause parallel builds to hang
+
+Release 3.5.1 (released Feb 16, 2021)
+=====================================
+
+Bugs fixed
+----------
+
+* #8883: autodoc: AttributeError is raised on assigning __annotations__ on
+ read-only class
+* #8884: html: minified js stemmers not included in the distributed package
+* #8885: html: AttributeError is raised if CSS/JS files are installed via
+ :confval:`html_context`
+* #8880: viewcode: ExtensionError is raised on incremental build after
+ unparsable python module found
+
+Release 3.5.0 (released Feb 14, 2021)
+=====================================
+
+Dependencies
+------------
+
+* LaTeX: ``multicol`` (it is anyhow a required part of the official latex2e
+ base distribution)
+
+Incompatible changes
+--------------------
+
+* Update Underscore.js to 1.12.0
+* #6550: html: The config variable ``html_add_permalinks`` is replaced by
+ :confval:`html_permalinks` and :confval:`html_permalinks_icon`
+
+Deprecated
+----------
+
+* pending_xref node for viewcode extension
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers``
+* ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue``
+* ``sphinx.builders.linkcheck.node_line_or_0()``
+* ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
+* ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
+* ``sphinx.ext.autodoc.importer.get_module_members()``
+* ``sphinx.ext.autosummary.generate._simple_info()``
+* ``sphinx.ext.autosummary.generate._simple_warn()``
+* ``sphinx.writers.html.HTMLTranslator.permalink_text``
+* ``sphinx.writers.html5.HTML5Translator.permalink_text``
+
+Features added
+--------------
+
+* #8022: autodoc: autodata and autoattribute directives does not show right-hand
+ value of the variable if docstring contains ``:meta hide-value:`` in
+ info-field-list
+* #8514: autodoc: Default values of overloaded functions are taken from actual
+ implementation if they're ellipsis
+* #8775: autodoc: Support type union operator (PEP-604) in Python 3.10 or above
+* #8297: autodoc: Allow to extend :confval:`autodoc_default_options` via
+ directive options
+* #759: autodoc: Add a new configuration :confval:`autodoc_preserve_defaults` as
+ an experimental feature. It preserves the default argument values of
+ functions in source code and keep them not evaluated for readability.
+* #8619: html: kbd role generates customizable HTML tags for compound keys
+* #8634: html: Allow to change the order of JS/CSS via ``priority`` parameter
+ for :meth:`.Sphinx.add_js_file()` and :meth:`.Sphinx.add_css_file()`
+* #6241: html: Allow to add JS/CSS files to the specific page when an extension
+ calls ``app.add_js_file()`` or ``app.add_css_file()`` on
+ :event:`html-page-context` event
+* #6550: html: Allow to use HTML permalink texts via
+ :confval:`html_permalinks_icon`
+* #1638: html: Add permalink icons to glossary terms
+* #8868: html search: performance issue with massive lists
+* #8867: html search: Update JavaScript stemmer code to the latest version of
+ Snowball (v2.1.0)
+* #8852: i18n: Allow to translate heading syntax in MyST-Parser
+* #8649: imgconverter: Skip availability check if builder supports the image
+ type
+* #8573: napoleon: Allow to change the style of custom sections using
+ :confval:`napoleon_custom_sections`
+* #8004: napoleon: Type definitions in Google style docstrings are rendered as
+ references when :confval:`napoleon_preprocess_types` enabled
+* #6241: mathjax: Include mathjax.js only on the document using equations
+* #8775: py domain: Support type union operator (PEP-604)
+* #8651: std domain: cross-reference for a rubric having inline item is broken
+* #7642: std domain: Optimize case-insensitive match of term
+* #8681: viewcode: Support incremental build
+* #8132: Add :confval:`project_copyright` as an alias of :confval:`copyright`
+* #207: Now :confval:`highlight_language` supports multiple languages
+* #2030: :rst:dir:`code-block` and :rst:dir:`literalinclude` supports automatic
+ dedent via no-argument ``:dedent:`` option
+* C++, also hyperlink operator overloads in expressions and alias declarations.
+* #8247: Allow production lists to refer to tokens from other production groups
+* #8813: Show what extension (or module) caused it on errors on event handler
+* #8213: C++: add ``maxdepth`` option to :rst:dir:`cpp:alias` to insert nested
+ declarations.
+* C, add ``noroot`` option to :rst:dir:`c:alias` to render only nested
+ declarations.
+* C++, add ``noroot`` option to :rst:dir:`cpp:alias` to render only nested
+ declarations.
+
+Bugs fixed
+----------
+
+* #8727: apidoc: namespace module file is not generated if no submodules there
+* #741: autodoc: inherited-members doesn't work for instance attributes on super
+ class
+* #8592: autodoc: ``:meta public:`` does not effect to variables
+* #8594: autodoc: empty __all__ attribute is ignored
+* #8315: autodoc: Failed to resolve struct.Struct type annotation
+* #8652: autodoc: All variable comments in the module are ignored if the module
+ contains invalid type comments
+* #8693: autodoc: Default values for overloaded functions are rendered as string
+* #8134: autodoc: crashes when mocked decorator takes arguments
+* #8800: autodoc: Uninitialized attributes in superclass are recognized as
+ undocumented
+* #8655: autodoc: Failed to generate document if target module contains an
+ object that raises an exception on ``hasattr()``
+* #8306: autosummary: mocked modules are documented as empty page when using
+ :recursive: option
+* #8232: graphviz: Image node is not rendered if graph file is in subdirectory
+* #8618: html: kbd role produces incorrect HTML when compound-key separators (-,
+ + or ^) are used as keystrokes
+* #8629: html: A type warning for html_use_opensearch is shown twice
+* #8714: html: kbd role with "Caps Lock" rendered incorrectly
+* #8123: html search: fix searching for terms containing + (Requires a custom
+ search language that does not split on +)
+* #8665: html theme: Could not override globaltoc_maxdepth in theme.conf
+* #8446: html: consecutive spaces are displayed as single space
+* #8745: i18n: crashes with KeyError when translation message adds a new auto
+ footnote reference
+* #4304: linkcheck: Fix race condition that could lead to checking the
+ availability of the same URL twice
+* #8791: linkcheck: The docname for each hyperlink is not displayed
+* #7118: sphinx-quickstart: questionare got Mojibake if libreadline unavailable
+* #8094: texinfo: image files on the different directory with document are not
+ copied
+* #8782: todo: Cross references in todolist get broken
+* #8720: viewcode: module pages are generated for epub on incremental build
+* #8704: viewcode: anchors are generated in incremental build after singlehtml
+* #8756: viewcode: highlighted code is generated even if not referenced
+* #8671: :confval:`highlight_options` is not working
+* #8341: C, fix intersphinx lookup types for names in declarations.
+* C, C++: in general fix intersphinx and role lookup types.
+* #8683: :confval:`html_last_updated_fmt` does not support UTC offset (%z)
+* #8683: :confval:`html_last_updated_fmt` generates wrong time zone for %Z
+* #1112: ``download`` role creates duplicated copies when relative path is
+ specified
+* #2616 (fifth item): LaTeX: footnotes from captions are not clickable,
+ and for manually numbered footnotes only first one with same number is
+ an hyperlink
+* #7576: LaTeX with French babel and memoir crash: "Illegal parameter number
+ in definition of ``\FNH@prefntext``"
+* #8055: LaTeX (docs): A potential display bug with the LaTeX generation step
+ in Sphinx (how to generate one-column index)
+* #8072: LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX
+* #8214: LaTeX: The :rst:role:`index` role and the glossary generate duplicate
+ entries in the LaTeX index (if both used for same term)
+* #8735: LaTeX: wrong internal links in pdf to captioned code-blocks when
+ :confval:`numfig` is not True
+* #8442: LaTeX: some indexed terms are ignored when using xelatex engine
+ (or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class
+* #8750: LaTeX: URLs as footnotes fail to show in PDF if originating from
+ inside function type signatures
+* #8780: LaTeX: long words in narrow columns may not be hyphenated
+* #8788: LaTeX: ``\titleformat`` last argument in sphinx.sty should be
+ bracketed, not braced (and is anyhow not needed)
+* #8849: LaTex: code-block printed out of margin (see the opt-in LaTeX syntax
+ boolean :ref:`verbatimforcewraps <latexsphinxsetupforcewraps>` for use via
+ the :ref:`'sphinxsetup' <latexsphinxsetup>` key of ``latex_elements``)
+* #8183: LaTeX: Remove substitution_reference nodes from doctree only on LaTeX
+ builds
+* #8865: LaTeX: Restructure the index nodes inside title nodes only on LaTeX
+ builds
+* #8796: LaTeX: potentially critical low level TeX coding mistake has gone
+ unnoticed so far
+* C, :rst:dir:`c:alias` skip symbols without explicit declarations
+ instead of crashing.
+* C, :rst:dir:`c:alias` give a warning when the root symbol is not declared.
+* C, ``expr`` role should start symbol lookup in the current scope.
+
+Release 3.4.3 (released Jan 08, 2021)
+=====================================
+
+Bugs fixed
+----------
+
+* #8655: autodoc: Failed to generate document if target module contains an
+ object that raises an exception on ``hasattr()``
+
+Release 3.4.2 (released Jan 04, 2021)
+=====================================
+
+Bugs fixed
+----------
+
+* #8164: autodoc: Classes that inherit mocked class are not documented
+* #8602: autodoc: The ``autodoc-process-docstring`` event is emitted to the
+ non-datadescriptors unexpectedly
+* #8616: autodoc: AttributeError is raised on non-class object is passed to
+ autoclass directive
+
+Release 3.4.1 (released Dec 25, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #8559: autodoc: AttributeError is raised when using forward-reference type
+ annotations
+* #8568: autodoc: TypeError is raised on checking slots attribute
+* #8567: autodoc: Instance attributes are incorrectly added to Parent class
+* #8566: autodoc: The ``autodoc-process-docstring`` event is emitted to the
+ alias classes unexpectedly
+* #8583: autodoc: Unnecessary object comparison via ``__eq__`` method
+* #8565: linkcheck: Fix PriorityQueue crash when link tuples are not
+ comparable
+
+Release 3.4.0 (released Dec 20, 2020)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #8105: autodoc: the signature of class constructor will be shown for decorated
+ classes, not a signature of decorator
+
+Deprecated
+----------
+
+* The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
+* The ``no_docstring`` argument of
+ ``sphinx.ext.autodoc.Documenter.add_content()``
+* ``sphinx.ext.autodoc.Documenter.get_object_members()``
+* ``sphinx.ext.autodoc.DataDeclarationDocumenter``
+* ``sphinx.ext.autodoc.GenericAliasDocumenter``
+* ``sphinx.ext.autodoc.InstanceAttributeDocumenter``
+* ``sphinx.ext.autodoc.SlotsAttributeDocumenter``
+* ``sphinx.ext.autodoc.TypeVarDocumenter``
+* ``sphinx.ext.autodoc.importer._getannotations()``
+* ``sphinx.ext.autodoc.importer._getmro()``
+* ``sphinx.pycode.ModuleAnalyzer.parse()``
+* ``sphinx.util.osutil.movefile()``
+* ``sphinx.util.requests.is_ssl_error()``
+
+Features added
+--------------
+
+* #8119: autodoc: Allow to determine whether a member not included in
+ ``__all__`` attribute of the module should be documented or not via
+ :event:`autodoc-skip-member` event
+* #8219: autodoc: Parameters for generic class are not shown when super class is
+ a generic class and show-inheritance option is given (in Python 3.7 or above)
+* autodoc: Add ``Documenter.config`` as a shortcut to access the config object
+* autodoc: Add Optional[t] to annotation of function and method if a default
+ value equal to None is set.
+* #8209: autodoc: Add ``:no-value:`` option to :rst:dir:`autoattribute` and
+ :rst:dir:`autodata` directive to suppress the default value of the variable
+* #8460: autodoc: Support custom types defined by typing.NewType
+* #8285: napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints
+ on source code automatically if any type is specified in docstring
+* #8236: napoleon: Support numpydoc's "Receives" section
+* #6914: Add a new event :event:`warn-missing-reference` to custom warning
+ messages when failed to resolve a cross-reference
+* #6914: Emit a detailed warning when failed to resolve a ``:ref:`` reference
+* #6629: linkcheck: The builder now handles rate limits. See
+ :confval:`linkcheck_rate_limit_timeout` for details.
+
+Bugs fixed
+----------
+
+* #7613: autodoc: autodoc does not respect __signature__ of the class
+* #4606: autodoc: the location of the warning is incorrect for inherited method
+* #8105: autodoc: the signature of class constructor is incorrect if the class
+ is decorated
+* #8434: autodoc: :confval:`autodoc_type_aliases` does not effect to variables
+ and attributes
+* #8443: autodoc: autodata directive can't create document for PEP-526 based
+ type annotated variables
+* #8443: autodoc: autoattribute directive can't create document for PEP-526
+ based uninitialized variables
+* #8480: autodoc: autoattribute could not create document for __slots__
+ attributes
+* #8503: autodoc: autoattribute could not create document for a GenericAlias as
+ class attributes correctly
+* #8534: autodoc: autoattribute could not create document for a commented
+ attribute in alias class
+* #8452: autodoc: autodoc_type_aliases doesn't work when autodoc_typehints is
+ set to "description"
+* #8541: autodoc: autodoc_type_aliases doesn't work for the type annotation to
+ instance attributes
+* #8460: autodoc: autodata and autoattribute directives do not display type
+ information of TypeVars
+* #8493: autodoc: references to builtins not working in class aliases
+* #8522: autodoc: ``__bool__`` method could be called
+* #8067: autodoc: A typehint for the instance variable having type_comment on
+ super class is not displayed
+* #8545: autodoc: a __slots__ attribute is not documented even having docstring
+* #741: autodoc: inherited-members doesn't work for instance attributes on super
+ class
+* #8477: autosummary: non utf-8 reST files are generated when template contains
+ multibyte characters
+* #8501: autosummary: summary extraction splits text after "el at." unexpectedly
+* #8524: html: Wrong url_root has been generated on a document named "index"
+* #8419: html search: Do not load ``language_data.js`` in non-search pages
+* #8549: i18n: ``-D gettext_compact=0`` is no longer working
+* #8454: graphviz: The layout option for graph and digraph directives don't work
+* #8131: linkcheck: Use GET when HEAD requests cause Too Many Redirects, to
+ accommodate infinite redirect loops on HEAD
+* #8437: Makefile: ``make clean`` with empty BUILDDIR is dangerous
+* #8365: py domain: ``:type:`` and ``:rtype:`` gives false ambiguous class
+ lookup warnings
+* #8352: std domain: Failed to parse an option that starts with bracket
+* #8519: LaTeX: Prevent page brake in the middle of a seealso
+* #8520: C, fix copying of AliasNode.
+
+Release 3.3.1 (released Nov 12, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #8372: autodoc: autoclass directive became slower than Sphinx 3.2
+* #7727: autosummary: raise PycodeError when documenting python package
+ without __init__.py
+* #8350: autosummary: autosummary_mock_imports causes slow down builds
+* #8364: C, properly initialize attributes in empty symbols.
+* #8399: i18n: Put system locale path after the paths specified by configuration
+
+Release 3.3.0 (released Nov 02, 2020)
+=====================================
+
+Deprecated
+----------
+
+* ``sphinx.builders.latex.LaTeXBuilder.usepackages``
+* ``sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref``
+* ``sphinx.ext.autodoc.SingledispatchFunctionDocumenter``
+* ``sphinx.ext.autodoc.SingledispatchMethodDocumenter``
+
+Features added
+--------------
+
+* #8100: html: Show a better error message for failures on copying
+ html_static_files
+* #8141: C: added a ``maxdepth`` option to :rst:dir:`c:alias` to insert
+ nested declarations.
+* #8081: LaTeX: Allow to add LaTeX package via ``app.add_latex_package()`` until
+ just before writing .tex file
+* #7996: manpage: Add :confval:`man_make_section_directory` to make a section
+ directory on build man page
+* #8289: epub: Allow to suppress "duplicated ToC entry found" warnings from epub
+ builder using :confval:`suppress_warnings`.
+* #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option
+* #8304: sphinx.testing: Register public markers in sphinx.testing.fixtures
+* #8051: napoleon: use the obj role for all See Also items
+* #8050: napoleon: Apply :confval:`napoleon_preprocess_types` to every field
+* C and C++, show line numbers for previous declarations when duplicates are
+ detected.
+* #8183: Remove substitution_reference nodes from doctree only on LaTeX builds
+
+Bugs fixed
+----------
+
+* #8085: i18n: Add support for having single text domain
+* #6640: i18n: Failed to override system message translation
+* #8143: autodoc: AttributeError is raised when False value is passed to
+ autodoc_default_options
+* #8103: autodoc: functools.cached_property is not considered as a property
+* #8190: autodoc: parsing error is raised if some extension replaces docstring
+ by string not ending with blank lines
+* #8142: autodoc: Wrong constructor signature for the class derived from
+ typing.Generic
+* #8157: autodoc: TypeError is raised when annotation has invalid __args__
+* #7964: autodoc: Tuple in default value is wrongly rendered
+* #8200: autodoc: type aliases break type formatting of autoattribute
+* #7786: autodoc: can't detect overloaded methods defined in other file
+* #8294: autodoc: single-string __slots__ is not handled correctly
+* #7785: autodoc: autodoc_typehints='none' does not effect to overloaded functions
+* #8192: napoleon: description is disappeared when it contains inline literals
+* #8142: napoleon: Potential of regex denial of service in google style docs
+* #8169: LaTeX: pxjahyper loaded even when latex_engine is not platex
+* #8215: LaTeX: 'oneside' classoption causes build warning
+* #8175: intersphinx: Potential of regex denial of service by broken inventory
+* #8277: sphinx-build: missing and redundant spacing (and etc) for console
+ output on building
+* #7973: imgconverter: Check availability of imagemagick many times
+* #8255: py domain: number in default argument value is changed from hexadecimal
+ to decimal
+* #8316: html: Prevent arrow keys changing page when button elements are focused
+* #8343: html search: Fix unnecessary load of images when parsing the document
+* #8254: html theme: Line numbers misalign with code lines
+* #8093: The highlight warning has wrong location in some builders (LaTeX,
+ singlehtml and so on)
+* #8215: Eliminate Fancyhdr build warnings for oneside documents
+* #8239: Failed to refer a token in productionlist if it is indented
+* #8268: linkcheck: Report HTTP errors when ``linkcheck_anchors`` is ``True``
+* #8245: linkcheck: take source directory into account for local files
+* #8321: linkcheck: ``tel:`` schema hyperlinks are detected as errors
+* #8323: linkcheck: An exit status is incorrect when links having unsupported
+ schema found
+* #8188: C, add missing items to internal object types dictionary,
+ e.g., preventing intersphinx from resolving them.
+* C, fix anon objects in intersphinx.
+* #8270, C++, properly reject functions as duplicate declarations if a
+ non-function declaration of the same name already exists.
+* C, fix references to function parameters.
+ Link to the function instead of a non-existing anchor.
+* #6914: figure numbers are unexpectedly assigned to uncaptioned items
+* #8320: make "inline" line numbers un-selectable
+
+Testing
+-------
+
+* #8257: Support parallel build in sphinx.testing
+
+Release 3.2.1 (released Aug 14, 2020)
+=====================================
+
+Features added
+--------------
+
+* #8095: napoleon: Add :confval:`napoleon_preprocess_types` to enable the type
+ preprocessor for numpy style docstrings
+* #8114: C and C++, parse function attributes after parameters and qualifiers.
+
+Bugs fixed
+----------
+
+* #8074: napoleon: Crashes during processing C-ext module
+* #8088: napoleon: "Inline literal start-string without end-string" warning in
+ Numpy style Parameters section
+* #8084: autodoc: KeyError is raised on documenting an attribute of the broken
+ class
+* #8091: autodoc: AttributeError is raised on documenting an attribute on Python
+ 3.5.2
+* #8099: autodoc: NameError is raised when target code uses ``TYPE_CHECKING``
+* C++, fix parsing of template template parameters, broken by the fix of #7944
+
+Release 3.2.0 (released Aug 08, 2020)
+=====================================
+
+Deprecated
+----------
+
+* ``sphinx.ext.autodoc.members_set_option()``
+* ``sphinx.ext.autodoc.merge_special_members_option()``
+* ``sphinx.writers.texinfo.TexinfoWriter.desc``
+* C, parsing of pre-v3 style type directives and roles, along with the options
+ :confval:`!c_allow_pre_v3` and :confval:`!c_warn_on_allowed_pre_v3`.
+
+Features added
+--------------
+
+* #2076: autodoc: Allow overriding of exclude-members in skip-member function
+* #8034: autodoc: ``:private-member:`` can take an explicit list of member names
+ to be documented
+* #2024: autosummary: Add :confval:`autosummary_filename_map` to avoid conflict
+ of filenames between two object with different case
+* #8011: autosummary: Support instance attributes as a target of autosummary
+ directive
+* #7849: html: Add :confval:`html_codeblock_linenos_style` to change the style
+ of line numbers for code-blocks
+* #7853: C and C++, support parameterized GNU style attributes.
+* #7888: napoleon: Add aliases Warn and Raise.
+* #7690: napoleon: parse type strings and make them hyperlinks as possible. The
+ conversion rule can be updated via :confval:`napoleon_type_aliases`
+* #8049: napoleon: Create a hyperlink for each the type of parameter when
+ :confval:`napoleon_use_param` is False
+* C, added :rst:dir:`c:alias` directive for inserting copies
+ of existing declarations.
+* #7745: html: inventory is broken if the docname contains a space
+* #7991: html search: Allow searching for numbers
+* #7902: html theme: Add a new option :confval:`globaltoc_maxdepth` to control
+ the behavior of globaltoc in sidebar
+* #7840: i18n: Optimize the dependencies check on bootstrap
+* #7768: i18n: :confval:`figure_language_filename` supports ``docpath`` token
+* #5208: linkcheck: Support checks for local links
+* #5090: setuptools: Link verbosity to distutils' -v and -q option
+* #6698: doctest: Add ``:trim-doctest-flags:`` and ``:no-trim-doctest-flags:``
+ options to doctest, testcode and testoutput directives
+* #7052: add ``:noindexentry:`` to the Python, C, C++, and Javascript domains.
+ Update the documentation to better reflect the relationship between this option
+ and the ``:noindex:`` option.
+* #7899: C, add possibility of parsing of some pre-v3 style type directives and
+ roles and try to convert them to equivalent v3 directives/roles.
+ Set the new option :confval:`!c_allow_pre_v3` to ``True`` to enable this.
+ The warnings printed from this functionality can be suppressed by setting
+ :confval:`!c_warn_on_allowed_pre_v3` to ``True``.
+ The functionality is immediately deprecated.
+* #7999: C, add support for named variadic macro arguments.
+* #8071: Allow to suppress "self referenced toctrees" warning
+
+Bugs fixed
+----------
+
+* #7886: autodoc: TypeError is raised on mocking generic-typed classes
+* #7935: autodoc: function signature is not shown when the function has a
+ parameter having ``inspect._empty`` as its default value
+* #7901: autodoc: type annotations for overloaded functions are not resolved
+* #904: autodoc: An instance attribute cause a crash of autofunction directive
+* #1362: autodoc: ``private-members`` option does not work for class attributes
+* #7983: autodoc: Generator type annotation is wrongly rendered in py36
+* #8030: autodoc: An uninitialized annotated instance variable is not documented
+ when ``:inherited-members:`` option given
+* #8032: autodoc: A type hint for the instance variable defined at parent class
+ is not shown in the document of the derived class
+* #8041: autodoc: An annotated instance variable on super class is not
+ documented when derived class has other annotated instance variables
+* #7839: autosummary: cannot handle umlauts in function names
+* #7865: autosummary: Failed to extract summary line when abbreviations found
+* #7866: autosummary: Failed to extract correct summary line when docstring
+ contains a hyperlink target
+* #7469: autosummary: "Module attributes" header is not translatable
+* #7940: apidoc: An extra newline is generated at the end of the rst file if a
+ module has submodules
+* #4258: napoleon: decorated special methods are not shown
+* #7799: napoleon: parameters are not escaped for combined params in numpydoc
+* #7780: napoleon: multiple parameters declaration in numpydoc was wrongly
+ recognized when ``napoleon_use_param=True``
+* #7715: LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links
+* #7846: html theme: XML-invalid files were generated
+* #7894: gettext: Wrong source info is shown when using rst_epilog
+* #7691: linkcheck: HEAD requests are not used for checking
+* #4888: i18n: Failed to add an explicit title to ``:ref:`` role on translation
+* #7928: py domain: failed to resolve a type annotation for the attribute
+* #8008: py domain: failed to parse a type annotation containing ellipsis
+* #7994: std domain: option directive does not generate old node_id compatible
+ with 2.x or older
+* #7968: i18n: The content of ``math`` directive is interpreted as reST on
+ translation
+* #7768: i18n: The ``root`` element for :confval:`figure_language_filename` is
+ not a path that user specifies in the document
+* #7993: texinfo: TypeError is raised for nested object descriptions
+* #7993: texinfo: a warning not supporting desc_signature_line node is shown
+* #7869: :rst:role:`abbr` role without an explanation will show the explanation
+ from the previous abbr role
+* #8048: graphviz: graphviz.css was copied on building non-HTML document
+* C and C++, removed ``noindex`` directive option as it did
+ nothing.
+* #7619: Duplicated node IDs are generated if node has multiple IDs
+* #2050: Symbols sections are appeared twice in the index page
+* #8017: Fix circular import in sphinx.addnodes
+* #7986: CSS: make "highlight" selector more robust
+* #7944: C++, parse non-type template parameters starting with
+ a dependent qualified name.
+* C, don't deepcopy the entire symbol table and make a mess every time an
+ enumerator is handled.
+
+Release 3.1.2 (released Jul 05, 2020)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #7650: autodoc: the signature of base function will be shown for decorated
+ functions, not a signature of decorator
+
+Bugs fixed
+----------
+
+* #7844: autodoc: Failed to detect module when relative module name given
+* #7856: autodoc: AttributeError is raised when non-class object is given to
+ the autoclass directive
+* #7850: autodoc: KeyError is raised for invalid mark up when autodoc_typehints
+ is 'description'
+* #7812: autodoc: crashed if the target name matches to both an attribute and
+ module that are same name
+* #7650: autodoc: function signature becomes ``(*args, **kwargs)`` if the
+ function is decorated by generic decorator
+* #7812: autosummary: generates broken stub files if the target code contains
+ an attribute and module that are same name
+* #7806: viewcode: Failed to resolve viewcode references on 3rd party builders
+* #7838: html theme: List items have extra vertical space
+* #7878: html theme: Undesired interaction between "overflow" and "float"
+
+Release 3.1.1 (released Jun 14, 2020)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #7808: napoleon: a type for attribute are represented as typed field
+
+Features added
+--------------
+
+* #7807: autodoc: Show detailed warning when type_comment is mismatched with its
+ signature
+
+Bugs fixed
+----------
+
+* #7808: autodoc: Warnings raised on variable and attribute type annotations
+* #7802: autodoc: EOFError is raised on parallel build
+* #7821: autodoc: TypeError is raised for overloaded C-ext function
+* #7805: autodoc: an object which descriptors returns is unexpectedly documented
+* #7807: autodoc: wrong signature is shown for the function using contextmanager
+* #7812: autosummary: generates broken stub files if the target code contains
+ an attribute and module that are same name
+* #7808: napoleon: Warnings raised on variable and attribute type annotations
+* #7811: sphinx.util.inspect causes circular import problem
+
+Release 3.1.0 (released Jun 08, 2020)
+=====================================
+
+Dependencies
+------------
+
+* #7746: mathjax: Update to 2.7.5
+
+Incompatible changes
+--------------------
+
+* #7477: imgconverter: Invoke "magick convert" command by default on Windows
+
+Deprecated
+----------
+
+* The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has
+ been changed to Sphinx object
+* ``sphinx.ext.autosummary.generate.AutosummaryRenderer`` takes an object type
+ as an argument
+* The ``ignore`` argument of ``sphinx.ext.autodoc.Documenter.get_doc()``
+* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
+ AutosummaryRenderer``
+* The ``module`` argument of ``sphinx.ext.autosummary.generate.
+ find_autosummary_in_docstring()``
+* The ``builder`` argument of ``sphinx.ext.autosummary.generate.
+ generate_autosummary_docs()``
+* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
+ generate_autosummary_docs()``
+* The ``ignore`` argument of ``sphinx.util.docstring.prepare_docstring()``
+* ``sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()``
+* ``sphinx.util.rpartition()``
+
+Features added
+--------------
+
+* LaTeX: Make the ``toplevel_sectioning`` setting optional in LaTeX theme
+* LaTeX: Allow to override papersize and pointsize from LaTeX themes
+* LaTeX: Add :confval:`latex_theme_options` to override theme options
+* #7410: Allow to suppress "circular toctree references detected" warnings using
+ :confval:`suppress_warnings`
+* C, added scope control directives, :rst:dir:`c:namespace`,
+ :rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`.
+* #2044: autodoc: Suppress default value for instance attributes
+* #7473: autodoc: consider a member public if docstring contains
+ ``:meta public:`` in info-field-list
+* #7487: autodoc: Allow to generate docs for singledispatch functions by
+ py:autofunction
+* #7143: autodoc: Support final classes and methods
+* #7384: autodoc: Support signatures defined by ``__new__()``, metaclasses and
+ builtin base classes
+* #2106: autodoc: Support multiple signatures on docstring
+* #4422: autodoc: Support GenericAlias in Python 3.7 or above
+* #3610: autodoc: Support overloaded functions
+* #7722: autodoc: Support TypeVar
+* #7466: autosummary: headings in generated documents are not translated
+* #7490: autosummary: Add ``:caption:`` option to autosummary directive to set a
+ caption to the toctree
+* #7469: autosummary: Support module attributes
+* #248, #6040: autosummary: Add ``:recursive:`` option to autosummary directive
+ to generate stub files recursively
+* #4030: autosummary: Add :confval:`autosummary_context` to add template
+ variables for custom templates
+* #7530: html: Support nested <kbd> elements
+* #7481: html theme: Add right margin to footnote/citation labels
+* #7482, #7717: html theme: CSS spacing for code blocks with captions and line
+ numbers
+* #7443: html theme: Add new options :confval:`globaltoc_collapse` and
+ :confval:`globaltoc_includehidden` to control the behavior of globaltoc in
+ sidebar
+* #7484: html theme: Avoid clashes between sidebar and other blocks
+* #7476: html theme: Relbar breadcrumb should contain current page
+* #7506: html theme: A canonical URL is not escaped
+* #7533: html theme: Avoid whitespace at the beginning of genindex.html
+* #7541: html theme: Add a "clearer" at the end of the "body"
+* #7542: html theme: Make admonition/topic/sidebar scrollable
+* #7543: html theme: Add top and bottom margins to tables
+* #7695: html theme: Add viewport meta tag for basic theme
+* #7721: html theme: classic: default codetextcolor/codebgcolor doesn't override
+ Pygments
+* C and C++: allow semicolon in the end of declarations.
+* C++, parse parameterized noexcept specifiers.
+* #7294: C++, parse expressions with user-defined literals.
+* C++, parse trailing return types.
+* #7143: py domain: Add ``:final:`` option to :rst:dir:`py:class`,
+ :rst:dir:`py:exception` and :rst:dir:`py:method` directives
+* #7596: py domain: Change a type annotation for variables to a hyperlink
+* #7770: std domain: :rst:dir:`option` directive support arguments in the form
+ of ``foo[=bar]``
+* #7582: napoleon: a type for attribute are represented like type annotation
+* #7734: napoleon: overescaped trailing underscore on attribute
+* #7247: linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP
+ headers for specific host
+* #7792: setuptools: Support ``--verbosity`` option
+* #7683: Add ``allowed_exceptions`` parameter to ``Sphinx.emit()`` to allow
+ handlers to raise specified exceptions
+* #7295: C++, parse (trailing) requires clauses.
+
+Bugs fixed
+----------
+
+* #6703: autodoc: incremental build does not work for imported objects
+* #7564: autodoc: annotations not to be shown for descriptors
+* #6588: autodoc: Decorated inherited method has no documentation
+* #7469: autodoc: The change of autodoc-process-docstring for variables is
+ cached unexpectedly
+* #7559: autodoc: misdetects a sync function is async
+* #6857: autodoc: failed to detect a classmethod on Enum class
+* #7562: autodoc: a typehint contains spaces is wrongly rendered under
+ :confval:`autodoc_typehints`\ ``='description'`` mode
+* #7551: autodoc: failed to import nested class
+* #7362: autodoc: does not render correct signatures for built-in functions
+* #7654: autodoc: ``Optional[Union[foo, bar]]`` is presented as
+ ``Union[foo, bar, None]``
+* #7629: autodoc: autofunction emits an unfriendly warning if an invalid object
+ specified
+* #7650: autodoc: undecorated signature is shown for decorated functions
+* #7676: autodoc: typo in the default value of autodoc_member_order
+* #7676: autodoc: wrong value for :member-order: option is ignored silently
+* #7676: autodoc: member-order="bysource" does not work for C module
+* #3673: autodoc: member-order="bysource" does not work for a module having
+ __all__
+* #7668: autodoc: wrong retann value is passed to a handler of
+ autodoc-process-signature
+* #7711: autodoc: fails with ValueError when processing numpy objects
+* #7791: autodoc: TypeError is raised on documenting singledispatch function
+* #7551: autosummary: a nested class is indexed as non-nested class
+* #7661: autosummary: autosummary directive emits warnings twices if failed to
+ import the target module
+* #7685: autosummary: The template variable "members" contains imported members
+ even if :confval:`autossummary_imported_members` is False
+* #7671: autosummary: The location of import failure warning is missing
+* #7535: sphinx-autogen: crashes when custom template uses inheritance
+* #7536: sphinx-autogen: crashes when template uses i18n feature
+* #7781: sphinx-build: Wrong error message when outdir is not directory
+* #7653: sphinx-quickstart: Fix multiple directory creation for nested relpath
+* #2785: html: Bad alignment of equation links
+* #7718: html theme: some themes does not respect background color of Pygments
+ style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional)
+* #7544: html theme: inconsistent padding in admonitions
+* #7581: napoleon: bad parsing of inline code in attribute docstrings
+* #7628: imgconverter: runs imagemagick once unnecessary for builders not
+ supporting images
+* #7610: incorrectly renders consecutive backslashes for docutils-0.16
+* #7646: handle errors on event handlers
+* #4187: LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents
+* #7701: LaTeX: Anonymous indirect hyperlink target causes duplicated labels
+* #7723: LaTeX: pdflatex crashed when URL contains a single quote
+* #7756: py domain: The default value for positional only argument is not shown
+* #7760: coverage: Add :confval:`coverage_show_missing_items` to show coverage
+ result to console
+* C++, fix rendering and xrefs in nested names explicitly starting
+ in global scope, e.g., ``::A::B``.
+* C, fix rendering and xrefs in nested names explicitly starting
+ in global scope, e.g., ``.A.B``.
+* #7763: C and C++, don't crash during display stringification of unary
+ expressions and fold expressions.
+
+Release 3.0.4 (released May 27, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #7567: autodoc: parametrized types are shown twice for generic types
+* #7637: autodoc: system defined TypeVars are shown in Python 3.9
+* #7696: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons
+* #7611: md5 fails when OpenSSL FIPS is enabled
+* #7626: release package does not contain ``CODE_OF_CONDUCT``
+
+Release 3.0.3 (released Apr 26, 2020)
+=====================================
+
+Features added
+--------------
+
+* C, parse array declarators with static, qualifiers, and VLA specification.
+
+Bugs fixed
+----------
+
+* #7516: autodoc: crashes if target object raises an error on accessing
+ its attributes
+
+Release 3.0.2 (released Apr 19, 2020)
+=====================================
+
+Features added
+--------------
+
+* C, parse attributes and add :confval:`c_id_attributes`
+ and :confval:`c_paren_attributes` to support user-defined attributes.
+
+Bugs fixed
+----------
+
+* #7461: py domain: fails with IndexError for empty tuple in type annotation
+* #7510: py domain: keyword-only arguments are documented as having a default of
+ None
+* #7418: std domain: :rst:role:`term` role could not match case-insensitively
+* #7461: autodoc: empty tuple in type annotation is not shown correctly
+* #7479: autodoc: Sphinx builds has been slower since 3.0.0 on mocking
+* C++, fix spacing issue in east-const declarations.
+* #7414: LaTeX: Xindy language options were incorrect
+* sphinx crashes with ImportError on python3.5.1
+
+Release 3.0.1 (released Apr 11, 2020)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #7418: std domain: :rst:role:`term` role becomes case sensitive
+
+Bugs fixed
+----------
+
+* #7428: py domain: a reference to class ``None`` emits a nitpicky warning
+* #7445: py domain: a return annotation ``None`` in the function signature is
+ not converted to a hyperlink when using intersphinx
+* #7418: std domain: duplication warning for glossary terms is case insensitive
+* #7438: C++, fix merging overloaded functions in parallel builds.
+* #7422: autodoc: fails with ValueError when using autodoc_mock_imports
+* #7435: autodoc: :confval:`autodoc_typehints`\ ``='description'`` doesn't
+ suppress typehints in signature for classes/methods
+* #7451: autodoc: fails with AttributeError when an object returns non-string
+ object as a ``__doc__`` member
+* #7423: crashed when giving a non-string object to logger
+* #7479: html theme: Do not include xmlns attribute with HTML 5 doctype
+* #7426: html theme: Escape some links in HTML templates
+
+Release 3.0.0 (released Apr 06, 2020)
+=====================================
+
+Dependencies
+------------
+
+3.0.0b1
+
+* LaTeX: drop dependency on :program:`extractbb` for image inclusion in
+ Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx`
+ since TeXLive2015 (refs: #6189)
+* babel-2.0 or above is available (Unpinned)
+
+Incompatible changes
+--------------------
+
+3.0.0b1
+
+* Drop features and APIs deprecated in 1.8.x
+* #247: autosummary: stub files are overwritten automatically by default. see
+ :confval:`autosummary_generate_overwrite` to change the behavior
+* #5923: autodoc: the members of ``object`` class are not documented by default
+ when ``:inherited-members:`` and ``:special-members:`` are given.
+* #6830: py domain: ``meta`` fields in info-field-list becomes reserved. They
+ are not displayed on output document now
+* #6417: py domain: doctree of desc_parameterlist has been changed. The
+ argument names, annotations and default values are wrapped with inline node
+* The structure of ``sphinx.events.EventManager.listeners`` has changed
+* Due to the scoping changes for :rst:dir:`productionlist` some uses of
+ :rst:role:`token` must be modified to include the scope which was previously
+ ignored.
+* #6903: Internal data structure of Python, reST and standard domains have
+ changed. The node_id is added to the index of objects and modules. Now they
+ contains a pair of docname and node_id for cross reference.
+* #7276: C++ domain: Non intended behavior is removed such as ``say_hello_``
+ links to ``.. cpp:function:: say_hello()``
+* #7210: js domain: Non intended behavior is removed such as ``parseInt_`` links
+ to ``.. js:function:: parseInt``
+* #7229: rst domain: Non intended behavior is removed such as ``numref_`` links
+ to ``.. rst:role:: numref``
+* #6903: py domain: Non intended behavior is removed such as ``say_hello_``
+ links to ``.. py:function:: say_hello()``
+* #7246: py domain: Drop special cross reference helper for exceptions,
+ functions and methods
+* The C domain has been rewritten, with additional directives and roles.
+ The existing ones are now more strict, resulting in new warnings.
+* The attribute ``sphinx_cpp_tagname`` in the ``desc_signature_line`` node
+ has been renamed to ``sphinx_line_type``.
+* #6462: double backslashes in domain directives are no longer replaced by
+ single backslashes as default. A new configuration value
+ :confval:`strip_signature_backslash` can be used by users to re-enable it.
+
+3.0.0 final
+
+* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()``
+
+Deprecated
+----------
+
+3.0.0b1
+
+* ``desc_signature['first']``
+* ``sphinx.directives.DescDirective``
+* ``sphinx.domains.std.StandardDomain.add_object()``
+* ``sphinx.domains.python.PyDecoratorMixin``
+* ``sphinx.ext.autodoc.get_documenters()``
+* ``sphinx.ext.autosummary.process_autosummary_toc()``
+* ``sphinx.parsers.Parser.app``
+* ``sphinx.testing.path.Path.text()``
+* ``sphinx.testing.path.Path.bytes()``
+* ``sphinx.util.inspect.getargspec()``
+* ``sphinx.writers.latex.LaTeXWriter.format_docclass()``
+
+Features added
+--------------
+
+3.0.0b1
+
+* #247: autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite
+ old stub file
+* #5923: autodoc: ``:inherited-members:`` option takes a name of anchestor class
+ not to document inherited members of the class and uppers
+* #6830: autodoc: consider a member private if docstring contains
+ ``:meta private:`` in info-field-list
+* #7165: autodoc: Support Annotated type (PEP-593)
+* #2815: autodoc: Support singledispatch functions and methods
+* #7079: autodoc: :confval:`autodoc_typehints` accepts ``"description"``
+ configuration. It shows typehints as object description
+* #7314: apidoc: Propagate ``--maxdepth`` option through package documents
+* #6558: glossary: emit a warning for duplicated glossary entry
+* #3106: domain: Register hyperlink target for index page automatically
+* #6558: std domain: emit a warning for duplicated generic objects
+* #6830: py domain: Add new event: :event:`object-description-transform`
+* #6895: py domain: Do not emit nitpicky warnings for built-in types
+* py domain: Support lambda functions in function signature
+* #6417: py domain: Allow to make a style for arguments of functions and methods
+* #7238, #7239: py domain: Emit a warning on describing a python object if the
+ entry is already added as the same name
+* #7341: py domain: type annotations in signature are converted to cross refs
+* Support priority of event handlers. For more detail, see
+ :py:meth:`.Sphinx.connect()`
+* #3077: Implement the scoping for :rst:dir:`productionlist` as indicated
+ in the documentation.
+* #1027: Support backslash line continuation in :rst:dir:`productionlist`.
+* #7108: config: Allow to show an error message from conf.py via ``ConfigError``
+* #7032: html: :confval:`html_scaled_image_link` will be disabled for images having
+ ``no-scaled-link`` class
+* #7144: Add CSS class indicating its domain for each desc node
+* #7211: latex: Use babel for Chinese document when using XeLaTeX
+* #6672: LaTeX: Support LaTeX Theming (experimental)
+* #7005: LaTeX: Add LaTeX styling macro for :rst:role:`kbd` role
+* #7220: genindex: Show "main" index entries at first
+* #7103: linkcheck: writes all links to ``output.json``
+* #7025: html search: full text search can be disabled for individual document
+ using ``:nosearch:`` file-wide metadata
+* #7293: html search: Allow to override JavaScript splitter via
+ ``SearchLanguage.js_splitter_code``
+* #7142: html theme: Add a theme option: ``pygments_dark_style`` to switch the
+ style of code-blocks in dark mode
+* The C domain has been rewritten adding for example:
+
+ - Cross-referencing respecting the current scope.
+ - Possible to document anonymous entities.
+ - More specific directives and roles for each type of entity,
+ e.g., handling scoping of enumerators.
+ - New role :rst:role:`c:expr` for rendering expressions and types
+ in text.
+
+* Added ``SphinxDirective.get_source_info()``
+ and ``SphinxRole.get_source_info()``.
+* #7324: sphinx-build: Emit a warning if multiple files having different file
+ extensions for same document found
+
+3.0.0 final
+
+* Added ``ObjectDescription.transform_content()``.
+
+Bugs fixed
+----------
+
+3.0.0b1
+
+* C++, fix cross reference lookup in certain cases involving
+ function overloads.
+* #5078: C++, fix cross reference lookup when a directive contains multiple
+ declarations.
+* C++, suppress warnings for directly dependent typenames in cross references
+ generated automatically in signatures.
+* #5637: autodoc: Incorrect handling of nested class names on show-inheritance
+* #7267: autodoc: error message for invalid directive options has wrong location
+* #7329: autodoc: info-field-list is wrongly generated from type hints into the
+ class description even if ``autoclass_content='class'`` set
+* #7331: autodoc: a cython-function is not recognized as a function
+* #5637: inheritance_diagram: Incorrect handling of nested class names
+* #7139: ``code-block:: guess`` does not work
+* #7325: html: source_suffix containing dot leads to wrong source link
+* #7357: html: Resizing SVG image fails with ValueError
+* #7278: html search: Fix use of ``html_file_suffix`` instead of
+ ``html_link_suffix`` in search results
+* #7297: html theme: ``bizstyle`` does not support ``sidebarwidth``
+* #3842: singlehtml: Path to images broken when master doc is not in source root
+* #7179: std domain: Fix whitespaces are suppressed on referring GenericObject
+* #7289: console: use bright colors instead of bold
+* #1539: C, parse array types.
+* #2377: C, parse function pointers even in complex types.
+* #7345: sphinx-build: Sphinx crashes if output directory exists as a file
+* #7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions
+* #6240: napoleon: Attributes and Methods sections ignore :noindex: option
+
+3.0.0 final
+
+* #7364: autosummary: crashed when :confval:`autosummary_generate` is False
+* #7370: autosummary: raises UnboundLocalError when unknown module given
+* #7367: C++, alternate operator spellings are now supported.
+* C, alternate operator spellings are now supported.
+* #7368: C++, comma operator in expressions, pack expansion in template
+ argument lists, and more comprehensive error messages in some cases.
+* C, C++, fix crash and wrong duplicate warnings related to anon symbols.
+* #6477: Escape first "!" in a cross reference linking no longer possible
+* #7219: py domain: The index entry generated by ``py:function`` directive is
+ different with one from ``index`` directive with "builtin" type
+* #7301: capital characters are not allowed for node_id
+* #7301: epub: duplicated node_ids are generated
+* #6564: html: a width of table was ignored on HTML builder
+* #7401: Incorrect argument is passed for :event:`env-get-outdated` handlers
+* #7355: autodoc: a signature of cython-function is not recognized well
+* #7222: autodoc: ``__wrapped__`` functions are not documented correctly
+* #7409: intersphinx: ValueError is raised when an extension sets up
+ :confval:`intersphinx_mapping` on :event:`config-inited` event
+* #7343: Sphinx builds has been slower since 2.4.0 on debug mode
+
+Release 2.4.5 (released Nov 18, 2021)
+=====================================
+
+Dependencies
+------------
+
+* #9807: Restrict docutils to 0.17.x or older
+
+Release 2.4.4 (released Mar 05, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #7197: LaTeX: platex cause error to build image directive with target url
+* #7223: Sphinx builds has been slower since 2.4.0
+
+Release 2.4.3 (released Feb 22, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #7184: autodoc: ``*args`` and ``**kwarg`` in type comments are not handled
+ properly
+* #7189: autodoc: classmethod coroutines are not detected
+* #7183: intersphinx: ``:attr:`` reference to property is broken
+* #6244, #6387: html search: Search breaks/hangs when built with dirhtml builder
+* #7195: todo: emit doctree-resolved event with non-document node incorrectly
+
+Release 2.4.2 (released Feb 19, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #7138: autodoc: ``autodoc.typehints`` crashed when variable has unbound object
+ as a value
+* #7156: autodoc: separator for keyword only arguments is not shown
+* #7146: autodoc: IndexError is raised on suppressed type_comment found
+* #7161: autodoc: typehints extension does not support parallel build
+* #7178: autodoc: TypeError is raised on fetching type annotations
+* #7151: crashed when extension assigns a value to ``env.indexentries``
+* #7170: text: Remove debug print
+* #7137: viewcode: Avoid to crash when non-python code given
+
+Release 2.4.1 (released Feb 11, 2020)
+=====================================
+
+Bugs fixed
+----------
+
+* #7120: html: crashed when on scaling SVG images which have float dimensions
+* #7126: autodoc: TypeError: 'getset_descriptor' object is not iterable
+
+Release 2.4.0 (released Feb 09, 2020)
+=====================================
+
+Deprecated
+----------
+
+* The ``decode`` argument of ``sphinx.pycode.ModuleAnalyzer()``
+* ``sphinx.directives.other.Index``
+* ``sphinx.environment.temp_data['gloss_entries']``
+* ``sphinx.environment.BuildEnvironment.indexentries``
+* ``sphinx.environment.collectors.indexentries.IndexEntriesCollector``
+* ``sphinx.ext.apidoc.INITPY``
+* ``sphinx.ext.apidoc.shall_skip()``
+* ``sphinx.io.FiletypeNotFoundError``
+* ``sphinx.io.get_filetype()``
+* ``sphinx.pycode.ModuleAnalyzer.encoding``
+* ``sphinx.roles.Index``
+* ``sphinx.util.detect_encoding()``
+* ``sphinx.util.get_module_source()``
+* ``sphinx.util.inspect.Signature``
+* ``sphinx.util.inspect.safe_getmembers()``
+* ``sphinx.writers.latex.LaTeXTranslator.settings.author``
+* ``sphinx.writers.latex.LaTeXTranslator.settings.contentsname``
+* ``sphinx.writers.latex.LaTeXTranslator.settings.docclass``
+* ``sphinx.writers.latex.LaTeXTranslator.settings.docname``
+* ``sphinx.writers.latex.LaTeXTranslator.settings.title``
+* ``sphinx.writers.latex.ADDITIONAL_SETTINGS``
+* ``sphinx.writers.latex.DEFAULT_SETTINGS``
+* ``sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG``
+* ``sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG``
+* ``sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG``
+* ``sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG``
+
+Features added
+--------------
+
+* #6910: inheritance_diagram: Make the background of diagrams transparent
+* #6446: duration: Add ``sphinx.ext.durations`` to inspect which documents slow
+ down the build
+* #6837: LaTeX: Support a nested table
+* #7115: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment
+ variable
+* #6966: graphviz: Support ``:class:`` option
+* #6696: html: ``:scale:`` option of image/figure directive not working for SVG
+ images (imagesize-1.2.0 or above is required)
+* #6994: imgconverter: Support illustrator file (.ai) to .png conversion
+* autodoc: Support Positional-Only Argument separator (PEP-570 compliant)
+* autodoc: Support type annotations for variables
+* #2755: autodoc: Add new event: :event:`autodoc-before-process-signature`
+* #2755: autodoc: Support type_comment style (ex. ``# type: (str) -> str``)
+ annotation (python3.8+ or `typed_ast <https://github.com/python/typed_ast>`_
+ is required)
+* #7051: autodoc: Support instance variables without defaults (PEP-526)
+* #6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows
+ typehints as object description if ``autodoc_typehints = "description"`` set.
+ This is an experimental extension and it will be integrated into autodoc core
+ in Sphinx 3.0
+* SphinxTranslator now calls visitor/departure method for super node class if
+ visitor/departure method for original node class not found
+* #6418: Add new event: :event:`object-description-transform`
+* py domain: :rst:dir:`py:data` and :rst:dir:`py:attribute` take new options
+ named ``:type:`` and ``:value:`` to describe its type and initial value
+* #6785: py domain: ``:py:attr:`` is able to refer properties again
+* #6772: apidoc: Add ``-q`` option for quiet mode
+
+Bugs fixed
+----------
+
+* #6925: html: Remove redundant type="text/javascript" from <script> elements
+* #7112: html: SVG image is not layouted as float even if aligned
+* #6906, #6907: autodoc: failed to read the source codes encoeded in cp1251
+* #6961: latex: warning for babel shown twice
+* #7059: latex: LaTeX compilation falls into infinite loop (wrapfig issue)
+* #6581: latex: ``:reversed:`` option for toctree does not effect to LaTeX build
+* #6559: Wrong node-ids are generated in glossary directive
+* #6986: apidoc: misdetects module name for .so file inside module
+* #6899: apidoc: private members are not shown even if ``--private`` given
+* #6327: apidoc: Support a python package consisted of __init__.so file
+* #6999: napoleon: fails to parse tilde in :exc: role
+* #7019: gettext: Absolute path used in message catalogs
+* #7023: autodoc: nested partial functions are not listed
+* #7023: autodoc: partial functions imported from other modules are listed as
+ module members without :impoprted-members: option
+* #6889: autodoc: Trailing comma in ``:members::`` option causes cryptic warning
+* #6568: autosummary: ``autosummary_imported_members`` is ignored on generating
+ a stub file for submodule
+* #7055: linkcheck: redirect is treated as an error
+* #7088: HTML template: If ``navigation_with_keys`` option is activated,
+ modifier keys are ignored, which means the feature can interfere with browser
+ features
+* #7090: std domain: Can't assign numfig-numbers for custom container nodes
+* #7106: std domain: enumerated nodes are marked as duplicated when extensions
+ call ``note_explicit_target()``
+* #7095: dirhtml: Cross references are broken via intersphinx and ``:doc:`` role
+* C++:
+
+ - Don't crash when using the ``struct`` role in some cases.
+ - Don't warn when using the ``var``/``member`` role for function
+ parameters.
+ - Render call and braced-init expressions correctly.
+* #7097: Filenames of images generated by
+ ``sphinx.transforms.post_transforms.images.ImageConverter``
+ or its subclasses (used for latex build) are now sanitized,
+ to prevent broken paths
+
+Release 2.3.1 (released Dec 22, 2019)
+=====================================
+
+Bugs fixed
+----------
+
+* #6936: sphinx-autogen: raises AttributeError
+
+Release 2.3.0 (released Dec 15, 2019)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #6742: ``end-before`` option of :rst:dir:`literalinclude` directive does not
+ match the first line of the code block.
+* #1331: Change default User-Agent header to ``"Sphinx/X.Y.Z requests/X.Y.Z
+ python/X.Y.Z"``. It can be changed via :confval:`user_agent`.
+* #6867: text: content of admonitions starts after a blank line
+
+Deprecated
+----------
+
+* ``sphinx.builders.gettext.POHEADER``
+* ``sphinx.io.SphinxStandaloneReader.app``
+* ``sphinx.io.SphinxStandaloneReader.env``
+* ``sphinx.util.texescape.tex_escape_map``
+* ``sphinx.util.texescape.tex_hl_escape_map_new``
+* ``sphinx.writers.latex.LaTeXTranslator.no_contractions``
+
+Features added
+--------------
+
+* #6707: C++, support bit-fields.
+* #267: html: Eliminate prompt characters of doctest block from copyable text
+* #6548: html: Use favicon for OpenSearch if available
+* #6729: html theme: agogo theme now supports ``rightsidebar`` option
+* #6780: Add PEP-561 Support
+* #6762: latex: Allow to load additional LaTeX packages via ``extrapackages`` key
+ of :confval:`latex_elements`
+* #1331: Add new config variable: :confval:`user_agent`
+* #6000: LaTeX: have backslash also be an inline literal word wrap break
+ character
+* #4186: LaTeX: Support upLaTeX as a new :confval:`latex_engine` (experimental)
+* #6812: Improve a warning message when extensions are not parallel safe
+* #6818: Improve Intersphinx performance for multiple remote inventories.
+* #2546: apidoc: .so file support
+* #6798: autosummary: emit ``autodoc-skip-member`` event on generating stub file
+* #6483: i18n: make explicit titles in toctree translatable
+* #6816: linkcheck: Add :confval:`linkcheck_auth` option to provide
+ authentication information when doing ``linkcheck`` builds
+* #6872: linkcheck: Handles HTTP 308 Permanent Redirect
+* #6613: html: Wrap section number in span tag
+* #6781: gettext: Add :confval:`gettext_last_translator` and
+ :confval:`gettext_language_team` to customize headers of POT file
+
+Bugs fixed
+----------
+
+* #6668: LaTeX: Longtable before header has incorrect distance
+ (refs: `latex3/latex2e#173`_)
+
+ .. _latex3/latex2e#173: https://github.com/latex3/latex2e/issues/173
+* #6618: LaTeX: Avoid section names at the end of a page
+* #6738: LaTeX: Do not replace unicode characters by LaTeX macros on unicode
+ supported LaTeX engines: ¶, §, €, ∞, ±, →, ‣, –, superscript and subscript
+ digits go through "as is" (as default OpenType font supports them)
+* #6704: linkcheck: Be defensive and handle newly defined HTTP error code
+* #6806: linkcheck: Failure on parsing content
+* #6655: image URLs containing ``data:`` causes gettext builder crashed
+* #6584: i18n: Error when compiling message catalogs on Hindi
+* #6718: i18n: KeyError is raised if section title and table title are same
+* #6743: i18n: :confval:`rst_prolog` breaks the translation
+* #6708: mathbase: Some deprecated functions have removed
+* #6709: autodoc: mock object does not work as a class decorator
+* #5070: epub: Wrong internal href fragment links
+* #6712: Allow not to install sphinx.testing as runtime (mainly for ALT Linux)
+* #6741: html: search result was broken with empty :confval:`html_file_suffix`
+* #6001: LaTeX does not wrap long code lines at backslash character
+* #6804: LaTeX: PDF build breaks if admonition of danger type contains
+ code-block long enough not to fit on one page
+* #6809: LaTeX: code-block in a danger type admonition can easily spill over
+ bottom of page
+* #6793: texinfo: Code examples broken following "sidebar"
+* #6813: An orphan warning is emitted for included document on Windows. Thanks
+ to @drillan
+* #6850: Fix smartypants module calls re.sub() with wrong options
+* #6824: HTML search: If a search term is partially matched in the title and
+ fully matched in a text paragraph on the same page, the search does not
+ include this match.
+* #6848: config.py shouldn't pop extensions from overrides
+* #6867: text: extra spaces are inserted to hyphenated words on folding lines
+* #6886: LaTeX: xelatex converts straight double quotes into right curly ones
+ (shows when :confval:`smartquotes` is ``False``)
+* #6890: LaTeX: even with smartquotes off, PDF output transforms straight
+ quotes and consecutive hyphens into curly quotes and dashes
+* #6876: LaTeX: multi-line display of authors on title page has ragged edges
+* #6887: Sphinx crashes with docutils-0.16b0
+* #6920: sphinx-build: A console message is wrongly highlighted
+* #6900: sphinx-build: ``-D`` option does not considers ``0`` and ``1`` as a
+ boolean value
+
+Release 2.2.2 (released Dec 03, 2019)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #6803: For security reason of python, parallel mode is disabled on macOS and
+ Python3.8+
+
+Bugs fixed
+----------
+
+* #6776: LaTeX: 2019-10-01 LaTeX release breaks :file:`sphinxcyrillic.sty`
+* #6815: i18n: French, Hindi, Chinese, Japanese and Korean translation messages
+ has been broken
+* #6803: parallel build causes AttributeError on macOS and Python3.8
+
+Release 2.2.1 (released Oct 26, 2019)
+=====================================
+
+Bugs fixed
+----------
+
+* #6641: LaTeX: Undefined control sequence ``\sphinxmaketitle``
+* #6710: LaTeX not well configured for Greek language as main language
+* #6759: validation of html static paths and extra paths no longer throws
+ an error if the paths are in different directories
+
+Release 2.2.0 (released Aug 19, 2019)
+=====================================
+
+Incompatible changes
+--------------------
+
+* apidoc: template files are renamed to ``.rst_t``
+* html: Field lists will be styled by grid layout
+
+Deprecated
+----------
+
+* ``sphinx.domains.math.MathDomain.add_equation()``
+* ``sphinx.domains.math.MathDomain.get_next_equation_number()``
+* The ``info`` and ``warn`` arguments of
+ ``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
+* ``sphinx.ext.autosummary.generate._simple_info()``
+* ``sphinx.ext.autosummary.generate._simple_warn()``
+* ``sphinx.ext.todo.merge_info()``
+* ``sphinx.ext.todo.process_todo_nodes()``
+* ``sphinx.ext.todo.process_todos()``
+* ``sphinx.ext.todo.purge_todos()``
+
+Features added
+--------------
+
+* #5124: graphviz: ``:graphviz_dot:`` option is renamed to ``:layout:``
+* #1464: html: emit a warning if :confval:`html_static_path` and
+ :confval:`html_extra_path` directories are inside output directory
+* #6514: html: Add a label to search input for accessability purposes
+* #5602: apidoc: Add ``--templatedir`` option
+* #6475: Add ``override`` argument to ``app.add_autodocumenter()``
+* #6310: imgmath: let :confval:`imgmath_use_preview` work also with the SVG
+ format for images rendering inline math
+* #6533: LaTeX: refactor visit_enumerated_list() to use ``\sphinxsetlistlabels``
+* #6628: quickstart: Use ``https://docs.python.org/3/`` for default setting of
+ :confval:`intersphinx_mapping`
+* #6419: sphinx-build: give reasons why rebuilt
+
+Bugs fixed
+----------
+
+* py domain: duplicated warning does not point the location of source code
+* #6499: html: Sphinx never updates a copy of :confval:`html_logo` even if
+ original file has changed
+* #1125: html theme: scrollbar is hard to see on classic theme and macOS
+* #5502: linkcheck: Consider HTTP 503 response as not an error
+* #6439: Make generated download links reproducible
+* #6486: UnboundLocalError is raised if broken extension installed
+* #6567: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
+ ``__init__()`` and ``__new__()``
+* #6574: autodoc: :confval:`autodoc_member_order` does not refer order of
+ imports when ``'bysource'`` order
+* #6574: autodoc: missing type annotation for variadic and keyword parameters
+* #6589: autodoc: Formatting issues with autodoc_typehints='none'
+* #6605: autodoc: crashed when target code contains custom method-like objects
+* #6498: autosummary: crashed with wrong autosummary_generate setting
+* #6507: autosummary: crashes without no autosummary_generate setting
+* #6511: LaTeX: autonumbered list can not be customized in LaTeX
+ since Sphinx 1.8.0 (refs: #6533)
+* #6531: Failed to load last environment object when extension added
+* #736: Invalid sort in pair index
+* #6527: :data:`last_updated` wrongly assumes timezone as UTC
+* #5592: std domain: :rst:dir:`option` directive registers an index entry for
+ each comma separated option
+* #6549: sphinx-build: Escaped characters in error messages
+* #6545: doctest comments not getting trimmed since Sphinx 1.8.0
+* #6561: glossary: Wrong hyperlinks are generated for non alphanumeric terms
+* #6620: i18n: classifiers of definition list are not translated with
+ docutils-0.15
+* #6474: ``DocFieldTransformer`` raises AttributeError when given directive is
+ not a subclass of ObjectDescription
+
+Release 2.1.2 (released Jun 19, 2019)
+=====================================
+
+Bugs fixed
+----------
+
+* #6497: custom lexers fails highlighting when syntax error
+* #6478, #6488: info field lists are incorrectly recognized
+
+Release 2.1.1 (released Jun 10, 2019)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #6447: autodoc: Stop to generate document for undocumented module variables
+
+Bugs fixed
+----------
+
+* #6442: LaTeX: admonitions of :rst:dir:`note` type can get separated from
+ immediately preceding section title by pagebreak
+* #6448: autodoc: crashed when autodocumenting classes with ``__slots__ = None``
+* #6451: autodoc: generates docs for "optional import"ed modules as variables
+* #6452: autosummary: crashed when generating document of properties
+* #6455: napoleon: docstrings for properties are not processed
+* #6436: napoleon: "Unknown target name" error if variable name ends with
+ underscore
+* #6440: apidoc: missing blank lines between modules
+
+Release 2.1.0 (released Jun 02, 2019)
+=====================================
+
+Incompatible changes
+--------------------
+
+* Ignore filenames without file extension given to ``Builder.build_specific()``
+ API directly
+* #6230: The anchor of term in glossary directive is changed if it is consisted
+ by non-ASCII characters
+* #4550: html: Centering tables by default using CSS
+* #6239: latex: xelatex and xeCJK are used for Chinese documents by default
+* ``Sphinx.add_lexer()`` now takes a Lexer class instead of instance. An
+ instance of lexers are still supported until Sphinx 3.x.
+
+Deprecated
+----------
+
+* ``sphinx.builders.latex.LaTeXBuilder.apply_transforms()``
+* ``sphinx.builders._epub_base.EpubBuilder.esc()``
+* ``sphinx.directives.Acks``
+* ``sphinx.directives.Author``
+* ``sphinx.directives.Centered``
+* ``sphinx.directives.Class``
+* ``sphinx.directives.CodeBlock``
+* ``sphinx.directives.Figure``
+* ``sphinx.directives.HList``
+* ``sphinx.directives.Highlight``
+* ``sphinx.directives.Include``
+* ``sphinx.directives.Index``
+* ``sphinx.directives.LiteralInclude``
+* ``sphinx.directives.Meta``
+* ``sphinx.directives.Only``
+* ``sphinx.directives.SeeAlso``
+* ``sphinx.directives.TabularColumns``
+* ``sphinx.directives.TocTree``
+* ``sphinx.directives.VersionChange``
+* ``sphinx.domains.python.PyClassmember``
+* ``sphinx.domains.python.PyModulelevel``
+* ``sphinx.domains.std.StandardDomain._resolve_citation_xref()``
+* ``sphinx.domains.std.StandardDomain.note_citations()``
+* ``sphinx.domains.std.StandardDomain.note_citation_refs()``
+* ``sphinx.domains.std.StandardDomain.note_labels()``
+* ``sphinx.environment.NoUri``
+* ``sphinx.ext.apidoc.format_directive()``
+* ``sphinx.ext.apidoc.format_heading()``
+* ``sphinx.ext.apidoc.makename()``
+* ``sphinx.ext.autodoc.importer.MockFinder``
+* ``sphinx.ext.autodoc.importer.MockLoader``
+* ``sphinx.ext.autodoc.importer.mock()``
+* ``sphinx.ext.autosummary.autolink_role()``
+* ``sphinx.ext.imgmath.DOC_BODY``
+* ``sphinx.ext.imgmath.DOC_BODY_PREVIEW``
+* ``sphinx.ext.imgmath.DOC_HEAD``
+* ``sphinx.transforms.CitationReferences``
+* ``sphinx.transforms.SmartQuotesSkipper``
+* ``sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()``
+* ``sphinx.util.node.find_source_node()``
+* ``sphinx.util.i18n.find_catalog()``
+* ``sphinx.util.i18n.find_catalog_files()``
+* ``sphinx.util.i18n.find_catalog_source_files()``
+
+For more details, see :ref:`deprecation APIs list <dev-deprecated-apis>`.
+
+Features added
+--------------
+
+* Add a helper class ``sphinx.transforms.post_transforms.SphinxPostTransform``
+* Add helper methods
+
+ - ``PythonDomain.note_module()``
+ - ``PythonDomain.note_object()``
+ - ``SphinxDirective.set_source_info()``
+
+* #6180: Support ``--keep-going`` with ``BuildDoc`` setup command
+* ``math`` directive now supports ``:class:`` option
+* todo: ``todo`` directive now supports ``:name:`` option
+* Enable override via environment of ``SPHINXOPTS`` and ``SPHINXBUILD`` Makefile
+ variables (refs: #6232, #6303)
+* #6287: autodoc: Unable to document bound instance methods exported as module
+ functions
+* #6289: autodoc: :confval:`autodoc_default_options` now supports
+ ``imported-members`` option
+* #4777: autodoc: Support coroutine
+* #744: autodoc: Support abstractmethod
+* #6325: autodoc: Support attributes in __slots__. For dict-style __slots__,
+ autodoc considers values as a docstring of the attribute
+* #6361: autodoc: Add :confval:`autodoc_typehints` to suppress typehints from
+ signature
+* #1063: autodoc: ``automodule`` directive now handles undocumented module level
+ variables
+* #6212 autosummary: Add :confval:`autosummary_imported_members` to display
+ imported members on autosummary
+* #6271: ``make clean`` is catastrophically broken if building into '.'
+* #6363: Support ``%O%`` environment variable in make.bat
+* #4777: py domain: Add ``:async:`` option to :rst:dir:`py:function` directive
+* py domain: Add new options to :rst:dir:`py:method` directive
+
+ - ``:abstractmethod:``
+ - ``:async:``
+ - ``:classmethod:``
+ - ``:property:``
+ - ``:staticmethod:``
+
+* rst domain: Add :rst:dir:`rst:directive:option` directive to describe the option
+ for directive
+* #6306: html: Add a label to search form for accessability purposes
+* #4390: html: Consistent and semantic CSS for signatures
+* #6358: The ``rawsource`` property of ``production`` nodes now contains the
+ full production rule
+* #6373: autosectionlabel: Allow suppression of warnings
+* coverage: Support a new ``coverage_ignore_pyobjects`` option
+* #6239: latex: Support to build Chinese documents
+
+Bugs fixed
+----------
+
+* #6230: Inappropriate node_id has been generated by glossary directive if term
+ is consisted by non-ASCII characters
+* #6213: ifconfig: contents after headings are not shown
+* commented term in glossary directive is wrongly recognized
+* #6299: rst domain: rst:directive directive generates waste space
+* #6379: py domain: Module index (py-modindex.html) has duplicate titles
+* #6331: man: invalid output when doctest follows rubric
+* #6351: "Hyperlink target is not referenced" message is shown even if
+ referenced
+* #6165: autodoc: ``tab_width`` setting of docutils has been ignored
+* #6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5
+* #6311: autosummary: autosummary table gets confused by complex type hints
+* #6350: autosummary: confused by an argument having some kind of default value
+* Generated Makefiles lack a final EOL (refs: #6232)
+* #6375: extlinks: Cannot escape angle brackets in link caption
+* #6378: linkcheck: Send commonly used User-Agent
+* #6387: html search: failed to search document with haiku and scrolls themes
+* #6408: html search: Fix the ranking of search results
+* #6406: Wrong year is returned for ``SOURCE_DATE_EPOCH``
+* #6402: image directive crashes by unknown image format
+* #6286: C++, allow 8 and 9 in hexadecimal integer literals.
+* #6305: Fix the string in quickstart for 'path' argument of parser
+* LaTeX: Figures in admonitions produced errors (refs: #6364)
+
+Release 2.0.1 (released Apr 08, 2019)
+=====================================
+
+Bugs fixed
+----------
+
+* LaTeX: some system labels are not translated
+* RemovedInSphinx30Warning is marked as pending
+* deprecation warnings are not emitted
+
+ - ``sphinx.application.CONFIG_FILENAME``
+ - ``sphinx.builders.htmlhelp``
+ - :confval:`!viewcode_import`
+
+* #6208: C++, properly parse full xrefs that happen to have a short xref as
+ prefix
+* #6220, #6225: napoleon: AttributeError is raised for raised section having
+ references
+* #6245: circular import error on importing SerializingHTMLBuilder
+* #6243: LaTeX: 'releasename' setting for latex_elements is ignored
+* #6244: html: Search function is broken with 3rd party themes
+* #6263: html: HTML5Translator crashed with invalid field node
+* #6262: html theme: The style of field lists has changed in bizstyle theme
+
+Release 2.0.0 (released Mar 29, 2019)
+=====================================
+
+Dependencies
+------------
+
+2.0.0b1
+
+* LaTeX builder now depends on TeX Live 2015 or above.
+* LaTeX builder (with ``'pdflatex'`` :confval:`latex_engine`) will process
+ Unicode Greek letters in text (not in math mark-up) via the text font and
+ will not escape them to math mark-up. See the discussion of the
+ ``'fontenc'`` key of :confval:`latex_elements`; such (optional) support for
+ Greek adds, for example on Ubuntu xenial, the ``texlive-lang-greek`` and (if
+ default font set-up is not modified) ``cm-super(-minimal)`` as additional
+ Sphinx LaTeX requirements.
+* LaTeX builder with :confval:`latex_engine` set to ``'xelatex'`` or to
+ ``'lualatex'`` requires (by default) the ``FreeFont`` fonts,
+ which in Ubuntu xenial are provided by package ``fonts-freefont-otf``, and
+ e.g. in Fedora 29 via package ``texlive-gnu-freefont``.
+* requests 2.5.0 or above
+* The six package is no longer a dependency
+* The sphinxcontrib-websupport package is no longer a dependency
+* Some packages are separated to sub packages:
+
+ - sphinxcontrib.applehelp
+ - sphinxcontrib.devhelp
+ - sphinxcontrib.htmlhelp
+ - sphinxcontrib.jsmath
+ - sphinxcontrib.serializinghtml
+ - sphinxcontrib.qthelp
+
+Incompatible changes
+--------------------
+
+2.0.0b1
+
+* Drop python 2.7 and 3.4 support
+* Drop docutils 0.11 support
+* Drop features and APIs deprecated in 1.7.x
+* The default setting for :confval:`master_doc` is changed to ``'index'`` which
+ has been longly used as default of sphinx-quickstart.
+* LaTeX: Move message resources to ``sphinxmessage.sty``
+* LaTeX: Stop using ``\captions<lang>`` macro for some labels
+* LaTeX: for ``'xelatex'`` and ``'lualatex'``, use the ``FreeFont`` OpenType
+ fonts as default choice (refs: #5645)
+* LaTeX: ``'xelatex'`` and ``'lualatex'`` now use ``\small`` in code-blocks
+ (due to ``FreeMono`` character width) like ``'pdflatex'`` already did (due
+ to ``Courier`` character width). You may need to adjust this via
+ :confval:`latex_elements` ``'fvset'`` key, in case of usage of some other
+ OpenType fonts (refs: #5768)
+* LaTeX: Greek letters in text are not escaped to math mode mark-up, and they
+ will use the text font not the math font. The ``LGR`` font encoding must be
+ added to the ``'fontenc'`` key of :confval:`latex_elements` for this to work
+ (only if it is needed by the document, of course).
+* LaTeX: setting the :confval:`language` to ``'en'`` triggered ``Sonny`` option
+ of ``fncychap``, now it is ``Bjarne`` to match case of no language specified.
+ (refs: #5772)
+* #5770: doctest: Follow :confval:`highlight_language` on highlighting doctest
+ block. As a result, they are highlighted as python3 by default.
+* The order of argument for ``HTMLTranslator``, ``HTML5Translator`` and
+ ``ManualPageTranslator`` are changed
+* LaTeX: hard-coded redefinitions of ``\l@section`` and ``\l@subsection``
+ formerly done during loading of ``'manual'`` docclass get executed later, at
+ time of ``\sphinxtableofcontents``. This means that custom user definitions
+ from LaTeX preamble now get overwritten. Use ``\sphinxtableofcontentshook``
+ to insert custom user definitions. See :ref:`latex-macros`.
+* quickstart: Simplify generated ``conf.py``
+* #4148: quickstart: some questions are removed. They are still able to specify
+ via command line options
+* websupport: unbundled from sphinx core. Please use sphinxcontrib-websupport
+* C++, the visibility of base classes is now always rendered as present in the
+ input. That is, ``private`` is now shown, where it was ellided before.
+* LaTeX: graphics inclusion of oversized images rescales to not exceed
+ the text width and height, even if width and/or height option were used.
+ (refs: #5956)
+* epub: ``epub_title`` defaults to the :confval:`project` option
+* #4550: All tables and figures without ``align`` option are displayed to center
+* #4587: html: Output HTML5 by default
+
+2.0.0b2
+
+* texinfo: image files are copied into ``name-figure`` directory
+
+Deprecated
+----------
+
+2.0.0b1
+
+* Support for evaluating Python 2 syntax is deprecated. This includes
+ configuration files which should be converted to Python 3.
+* The arguments of ``EpubBuilder.build_mimetype()``,
+ ``EpubBuilder.build_container()``, ``EpubBuilder.bulid_content()``,
+ ``EpubBuilder.build_toc()`` and ``EpubBuilder.build_epub()``
+* The arguments of ``Epub3Builder.build_navigation_doc()``
+* The config variables
+
+ - :confval:`html_experimental_html5_writer`
+
+* The ``encoding`` argument of ``autodoc.Documenter.get_doc()``,
+ ``autodoc.DocstringSignatureMixin.get_doc()``,
+ ``autodoc.DocstringSignatureMixin._find_signature()``, and
+ ``autodoc.ClassDocumenter.get_doc()`` are deprecated.
+* The ``importer`` argument of ``sphinx.ext.autodoc.importer._MockModule``
+* The ``nodetype`` argument of ``sphinx.search.WordCollector.
+ is_meta_keywords()``
+* The ``suffix`` argument of ``env.doc2path()`` is deprecated.
+* The string style ``base`` argument of ``env.doc2path()`` is deprecated.
+* The fallback to allow omitting the ``filename`` argument from an overridden
+ ``IndexBuilder.feed()`` method is deprecated.
+* ``sphinx.addnodes.abbreviation``
+* ``sphinx.application.Sphinx._setting_up_extension``
+* ``sphinx.builders.epub3.Epub3Builder.validate_config_value()``
+* ``sphinx.builders.html.SingleFileHTMLBuilder``
+* ``sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()``
+* ``sphinx.cmd.quickstart.term_decode()``
+* ``sphinx.cmd.quickstart.TERM_ENCODING``
+* ``sphinx.config.check_unicode()``
+* ``sphinx.config.string_classes``
+* ``sphinx.domains.cpp.DefinitionError.description``
+* ``sphinx.domains.cpp.NoOldIdError.description``
+* ``sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded``
+* ``sphinx.ext.autodoc.importer._MockImporter``
+* ``sphinx.ext.autosummary.Autosummary.warn()``
+* ``sphinx.ext.autosummary.Autosummary.genopt``
+* ``sphinx.ext.autosummary.Autosummary.warnings``
+* ``sphinx.ext.autosummary.Autosummary.result``
+* ``sphinx.ext.doctest.doctest_encode()``
+* ``sphinx.io.SphinxBaseFileInput``
+* ``sphinx.io.SphinxFileInput.supported``
+* ``sphinx.io.SphinxRSTFileInput``
+* ``sphinx.registry.SphinxComponentRegistry.add_source_input()``
+* ``sphinx.roles.abbr_role()``
+* ``sphinx.roles.emph_literal_role()``
+* ``sphinx.roles.menusel_role()``
+* ``sphinx.roles.index_role()``
+* ``sphinx.roles.indexmarkup_role()``
+* ``sphinx.testing.util.remove_unicode_literal()``
+* ``sphinx.util.attrdict``
+* ``sphinx.util.force_decode()``
+* ``sphinx.util.get_matching_docs()``
+* ``sphinx.util.inspect.Parameter``
+* ``sphinx.util.jsonimpl``
+* ``sphinx.util.osutil.EEXIST``
+* ``sphinx.util.osutil.EINVAL``
+* ``sphinx.util.osutil.ENOENT``
+* ``sphinx.util.osutil.EPIPE``
+* ``sphinx.util.osutil.walk()``
+* ``sphinx.util.PeekableIterator``
+* ``sphinx.util.pycompat.NoneType``
+* ``sphinx.util.pycompat.TextIOWrapper``
+* ``sphinx.util.pycompat.UnicodeMixin``
+* ``sphinx.util.pycompat.htmlescape``
+* ``sphinx.util.pycompat.indent``
+* ``sphinx.util.pycompat.sys_encoding``
+* ``sphinx.util.pycompat.terminal_safe()``
+* ``sphinx.util.pycompat.u``
+* ``sphinx.writers.latex.ExtBabel``
+* ``sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()``
+* ``sphinx.writers.latex.LaTeXTranslator.babel_defmacro()``
+* ``sphinx.writers.latex.LaTeXTranslator.collect_footnotes()``
+* ``sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()``
+* ``sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()``
+* ``sphinx.writers.text.TextTranslator._make_depart_admonition()``
+* template variables for LaTeX template
+
+ - ``logo``
+ - ``numfig_format``
+ - ``pageautorefname``
+ - ``translatablestrings``
+
+For more details, see :ref:`deprecation APIs list <dev-deprecated-apis>`.
+
+Features added
+--------------
+
+2.0.0b1
+
+* #1618: The search results preview of generated HTML documentation is
+ reader-friendlier: instead of showing the snippets as raw reStructuredText
+ markup, Sphinx now renders the corresponding HTML. This means the Sphinx
+ extension `Sphinx: pretty search results`__ is no longer necessary. Note that
+ changes to the search function of your custom or 3rd-party HTML template might
+ overwrite this improvement.
+
+ __ https://github.com/sphinx-contrib/sphinx-pretty-searchresults
+
+* #4182: autodoc: Support :confval:`suppress_warnings`
+* #5533: autodoc: :confval:`autodoc_default_options` supports ``member-order``
+* #5394: autodoc: Display readable names in type annotations for mocked objects
+* #5459: autodoc: :confval:`autodoc_default_options` accepts ``True`` as a value
+* #1148: autodoc: Add :rst:dir:`autodecorator` directive for decorators
+* #5635: autosummary: Add :confval:`autosummary_mock_imports` to mock external
+ libraries on importing targets
+* #4018: htmlhelp: Add :confval:`htmlhelp_file_suffix` and
+ :confval:`htmlhelp_link_suffix`
+* #5559: text: Support complex tables (colspan and rowspan)
+* LaTeX: support rendering (not in math, yet) of Greek and Cyrillic Unicode
+ letters in non-Cyrillic document even with ``'pdflatex'`` as
+ :confval:`latex_engine` (refs: #5645)
+* #5660: The ``versionadded``, ``versionchanged`` and ``deprecated`` directives
+ are now generated with their own specific CSS classes
+ (``added``, ``changed`` and ``deprecated``, respectively) in addition to the
+ generic ``versionmodified`` class.
+* #5841: apidoc: Add --extensions option to sphinx-apidoc
+* #4981: C++, added an alias directive for inserting lists of declarations,
+ that references existing declarations (e.g., for making a synopsis).
+* C++: add ``cpp:struct`` to complement ``cpp:class``.
+* #1341 the HTML search considers words that contain a search term of length
+ three or longer a match.
+* #4611: epub: Show warning for duplicated ToC entries
+* #1851: Allow to omit an argument for :rst:dir:`code-block` directive. If
+ omitted, it follows :rst:dir:`highlight` or :confval:`highlight_language`
+* #4587: html: Add :confval:`html4_writer` to use old HTML4 writer
+* #6016: HTML search: A placeholder for the search summary prevents search
+ result links from changing their position when the search terminates. This
+ makes navigating search results easier.
+* #5196: linkcheck also checks remote images exist
+* #5924: githubpages: create CNAME file for custom domains when
+ :confval:`html_baseurl` set
+* #4261: autosectionlabel: restrict the labeled sections by new config value;
+ :confval:`autosectionlabel_maxdepth`
+
+
+Bugs fixed
+----------
+
+2.0.0b1
+
+* #1682: LaTeX: writer should not translate Greek unicode, but use textgreek
+ package
+* #5247: LaTeX: PDF does not build with default font config for Russian
+ language and ``'xelatex'`` or ``'lualatex'`` as :confval:`latex_engine`
+ (refs: #5251)
+* #5248: LaTeX: Greek letters in section titles disappear from PDF bookmarks
+* #5249: LaTeX: Unicode Greek letters in math directive break PDF build
+ (fix requires extra set-up, see :confval:`latex_elements` ``'textgreek'`` key
+ and/or :confval:`latex_engine` setting)
+* #5772: LaTeX: should the Bjarne style of fncychap be used for English also
+ if passed as language option?
+* #5179: LaTeX: (lualatex only) escaping of ``>`` by ``\textgreater{}`` is not
+ enough as ``\textgreater{}\textgreater{}`` applies TeX-ligature
+* LaTeX: project name is not escaped if :confval:`latex_documents` omitted
+* LaTeX: authors are not shown if :confval:`latex_documents` omitted
+* HTML: Invalid HTML5 file is generated for a glossary having multiple terms for
+ one description (refs: #4611)
+* QtHelp: OS dependent path separator is used in .qhp file
+* HTML search: search always returns nothing when multiple search terms are
+ used and one term is shorter than three characters
+
+2.0.0b2
+
+* #6096: html: Anchor links are not added to figures
+* #3620: html: Defer searchindex.js rather than loading it via ajax
+* #6113: html: Table cells and list items have large margins
+* #5508: ``linenothreshold`` option for ``highlight`` directive was ignored
+* texinfo: ``make install-info`` causes syntax error
+* texinfo: ``make install-info`` fails on macOS
+* #3079: texinfo: image files are not copied on ``make install-info``
+* #5391: A cross reference in heading is rendered as literal
+* #5946: C++, fix ``cpp:alias`` problems in LaTeX (and singlehtml)
+* #6147: classes attribute of ``citation_reference`` node is lost
+* AssertionError is raised when custom ``citation_reference`` node having
+ classes attribute refers missing citation (refs: #6147)
+* #2155: Support ``code`` directive
+* C++, fix parsing of braced initializers.
+* #6172: AttributeError is raised for old styled index nodes
+* #4872: inheritance_diagram: correctly describe behavior of ``parts`` option in
+ docs, allow negative values.
+* #6178: i18n: Captions missing in translations for hidden TOCs
+
+2.0.0 final
+
+* #6196: py domain: unexpected prefix is generated
+
+Testing
+-------
+
+2.0.0b1
+
+* Stop to use ``SPHINX_TEST_TEMPDIR`` envvar
+
+2.0.0b2
+
+* Add a helper function: ``sphinx.testing.restructuredtext.parse()``
+
+Release 1.8.6 (released Nov 18, 2021)
+=====================================
+
+Dependencies
+------------
+
+* #9807: Restrict docutils to 0.17.x or older
+
+Release 1.8.5 (released Mar 10, 2019)
+=====================================
+
+Bugs fixed
+----------
+
+* LaTeX: Remove extraneous space after author names on PDF title page (refs:
+ #6004)
+* #6026: LaTeX: A cross reference to definition list does not work
+* #6046: LaTeX: ``TypeError`` is raised when invalid latex_elements given
+* #6067: LaTeX: images having a target are concatenated to next line
+* #6067: LaTeX: images having a target are not aligned even if specified
+* #6149: LaTeX: ``:index:`` role in titles causes ``Use of \@icentercr doesn't
+ match its definition`` error on latexpdf build
+* #6019: imgconverter: Including multipage PDF fails
+* #6047: autodoc: ``autofunction`` emits a warning for method objects
+* #6028: graphviz: Ensure the graphviz filenames are reproducible
+* #6068: doctest: ``skipif`` option may remove the code block from documentation
+* #6136: ``:name:`` option for ``math`` directive causes a crash
+* #6139: intersphinx: ValueError on failure reporting
+* #6135: changes: Fix UnboundLocalError when any module found
+* #3859: manpage: code-block captions are not displayed correctly
+
+Release 1.8.4 (released Feb 03, 2019)
+=====================================
+
+Bugs fixed
+----------
+
+* #3707: latex: no bold checkmark (✔) available.
+* #5605: with the documentation language set to Chinese, English words could not
+ be searched.
+* #5889: LaTeX: user ``numfig_format`` is stripped of spaces and may cause
+ build failure
+* C++, fix hyperlinks for declarations involving east cv-qualifiers.
+* #5755: C++, fix duplicate declaration error on function templates with
+ constraints in the return type.
+* C++, parse unary right fold expressions and binary fold expressions.
+* pycode could not handle egg files on windows
+* #5928: KeyError: 'DOCUTILSCONFIG' when running build
+* #5936: LaTeX: PDF build broken by inclusion of image taller than page height
+ in an admonition
+* #5231: "make html" does not read and build "po" files in "locale" dir
+* #5954: ``:scale:`` image option may break PDF build if image in an admonition
+* #5966: mathjax has not been loaded on incremental build
+* #5960: LaTeX: modified PDF layout since September 2018 TeXLive update of
+ :file:`parskip.sty`
+* #5948: LaTeX: duplicated labels are generated for sections
+* #5958: versionadded directive causes crash with Python 3.5.0
+* #5995: autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7
+* #5871: texinfo: a section title ``.`` is not allowed
+
+Release 1.8.3 (released Dec 26, 2018)
+=====================================
+
+Features added
+--------------
+
+* LaTeX: it is possible to insert custom material to appear on back of title
+ page, see discussion of ``'maketitle'`` key of :confval:`latex_elements`
+ (``'manual'`` docclass only)
+
+Bugs fixed
+----------
+
+* #5725: mathjax: Use CDN URL for "latest" version by default
+* #5460: html search does not work with some 3rd party themes
+* #5520: LaTeX, caption package incompatibility since Sphinx 1.6
+* #5614: autodoc: incremental build is broken when builtin modules are imported
+* #5627: qthelp: index.html missing in QtHelp
+* #5659: linkcheck: crashes for a hyperlink containing multibyte character
+* #5754: DOC: Fix some mistakes in :doc:`/latex`
+* #5810: LaTeX: sphinxVerbatim requires explicit "hllines" set-up since 1.6.6
+ (refs: #1238)
+* #5636: C++, fix parsing of floating point literals.
+* #5496 (again): C++, fix assertion in partial builds with duplicates.
+* #5724: quickstart: sphinx-quickstart fails when $LC_ALL is empty
+* #1956: Default conf.py is not PEP8-compliant
+* #5849: LaTeX: document class ``\maketitle`` is overwritten with no
+ possibility to use original meaning in place of Sphinx custom one
+* #5834: apidoc: wrong help for ``--tocfile``
+* #5800: todo: crashed if todo is defined in TextElement
+* #5846: htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
+* htmlhelp: broken .hhk file generated when title contains a double quote
+
+Release 1.8.2 (released Nov 11, 2018)
+=====================================
+
+Incompatible changes
+--------------------
+
+* #5497: Do not include MathJax.js and jsmath.js unless it is really needed
+
+Features added
+--------------
+
+* #5471: Show appropriate deprecation warnings
+
+Bugs fixed
+----------
+
+* #5490: latex: enumerated list causes a crash with recommonmark
+* #5492: sphinx-build fails to build docs w/ Python < 3.5.2
+* #3704: latex: wrong ``\label`` positioning for figures with a legend
+* #5496: C++, fix assertion when a symbol is declared more than twice.
+* #5493: gettext: crashed with broken template
+* #5495: csv-table directive with file option in included file is broken (refs:
+ #4821)
+* #5498: autodoc: unable to find type hints for a ``functools.partial``
+* #5480: autodoc: unable to find type hints for unresolvable Forward references
+* #5419: incompatible math_block node has been generated
+* #5548: Fix ensuredir() in case of pre-existing file
+* #5549: graphviz Correctly deal with non-existing static dir
+* #3002: i18n: multiple footnote_references referring same footnote cause
+ duplicated node_ids
+* #5563: latex: footnote_references generated by extension causes a LaTeX
+ builder crash
+* #5561: make all-pdf fails with old xindy version
+* #5557: quickstart: --no-batchfile isn't honored
+* #3080: texinfo: multiline rubrics are broken
+* #3080: texinfo: multiline citations are broken
+
+Release 1.8.1 (released Sep 22, 2018)
+=====================================
+
+Incompatible changes
+--------------------
+
+* LaTeX ``\pagestyle`` commands have been moved to the LaTeX template. No
+ changes in PDF, except possibly if ``\sphinxtableofcontents``, which
+ contained them, had been customized in :file:`conf.py`. (refs: #5455)
+
+Bugs fixed
+----------
+
+* #5418: Incorrect default path for sphinx-build -d/doctrees files
+* #5421: autodoc emits deprecation warning for :confval:`autodoc_default_flags`
+* #5422: lambda object causes PicklingError on storing environment
+* #5417: Sphinx fails to build with syntax error in Python 2.7.5
+* #4911: add latexpdf to make.bat for non make-mode
+* #5436: Autodoc does not work with enum subclasses with properties/methods
+* #5437: autodoc: crashed on modules importing eggs
+* #5433: latex: ImportError: cannot import name 'DEFAULT_SETTINGS'
+* #5431: autodoc: ``autofunction`` emits a warning for callable objects
+* #5457: Fix TypeError in error message when override is prohibited
+* #5453: PDF builds of 'howto' documents have no page numbers
+* #5463: mathbase: math_role and MathDirective was disappeared in 1.8.0
+* #5454: latex: Index has disappeared from PDF for Japanese documents
+* #5432: py domain: ``:type:`` field can't process ``:term:`` references
+* #5426: py domain: TypeError has been raised for class attribute
+
+Release 1.8.0 (released Sep 13, 2018)
+=====================================
+
+Dependencies
+------------
+
+1.8.0b1
+
+* LaTeX: :confval:`latex_use_xindy`, if ``True`` (default for
+ ``xelatex/lualatex``), instructs ``make latexpdf`` to use :program:`xindy`
+ for general index. Make sure your LaTeX distribution includes it.
+ (refs: #5134)
+* LaTeX: ``latexmk`` is required for ``make latexpdf`` on Windows
+
+Incompatible changes
+--------------------
+
+1.8.0b2
+
+* #5282: html theme: refer ``pygments_style`` settings of HTML themes
+ preferentially
+* The URL of download files are changed
+* #5127: quickstart: ``Makefile`` and ``make.bat`` are not overwritten if exists
+
+1.8.0b1
+
+* #5156: the :py:mod:`sphinx.ext.graphviz` extension runs ``dot`` in the
+ directory of the document being built instead of in the root directory of
+ the documentation.
+* #4460: extensions which stores any data to environment should return the
+ version of its env data structure as metadata. In detail, please see
+ :ref:`ext-metadata`.
+* Sphinx expects source parser modules to have supported file formats as
+ ``Parser.supported`` attribute
+* The default value of :confval:`epub_author` and :confval:`epub_publisher` are
+ changed from ``'unknown'`` to the value of :confval:`author`. This is same as
+ a ``conf.py`` file sphinx-build generates.
+* The ``gettext_compact`` attribute is removed from ``document.settings``
+ object. Please use ``config.gettext_compact`` instead.
+* The processing order on reading phase is changed. smart_quotes, sphinx
+ domains, :event:`doctree-read` event and versioning doctrees are invoked
+ earlier than so far. For more details, please read a description of
+ :py:meth:`.Sphinx.add_transform()`
+* #4827: All ``substitution_definition`` nodes are removed from doctree on
+ reading phase
+* ``docutils.conf`` in ``$HOME`` or ``/etc`` directories are ignored. Only
+ ``docutils.conf`` from confdir is obeyed.
+* #789: ``:samp:`` role supports to escape curly braces with backslash
+* #4811: The files under :confval:`html_static_path` are excluded from source
+ files.
+* latex: Use ``\sphinxcite`` for citation references instead ``\hyperref``
+* The config value :confval:`!viewcode_import` is renamed to
+ :confval:`viewcode_follow_imported_members` (refs: #4035)
+* #1857: latex: :confval:`latex_show_pagerefs` does not add pagerefs for
+ citations
+* #4648: latex: Now "rubric" elements are rendered as unnumbered section title
+* #4983: html: The anchor for productionlist tokens has been changed
+* Modifying a template variable ``script_files`` in templates is allowed now.
+ Please use ``app.add_js_file()`` instead.
+* #5072: Save environment object also with only new documents
+* #5035: qthelp builder allows dashes in :confval:`qthelp_namespace`
+* LaTeX: with lualatex or xelatex use by default :program:`xindy` as
+ UTF-8 able replacement of :program:`makeindex` (refs: #5134). After
+ upgrading Sphinx, please clean latex build repertory of existing project
+ before new build.
+* #5163: html: hlist items are now aligned to top
+* ``highlightlang`` directive is processed on resolving phase
+* #4000: LaTeX: template changed. Following elements moved to it:
+
+ - ``\begin{document}``
+ - ``shorthandoff`` variable
+ - ``maketitle`` variable
+ - ``tableofcontents`` variable
+
+Deprecated
+----------
+
+1.8.0b2
+
+* ``sphinx.io.SphinxI18nReader.set_lineno_for_reporter()`` is deprecated
+* ``sphinx.io.SphinxI18nReader.line`` is deprecated
+* ``sphinx.util.i18n.find_catalog_source_file()`` has changed; the
+ *gettext_compact* argument has been deprecated
+* #5403: ``sphinx.util.images.guess_mimetype()`` has changed; the *content*
+ argument has been deprecated
+
+1.8.0b1
+
+* :confval:`source_parsers` is deprecated
+* :confval:`autodoc_default_flags` is deprecated
+* quickstart: ``--epub`` option becomes default, so it is deprecated
+* Drop function based directive support. For now, Sphinx only supports class
+ based directives (see :class:`~docutils.parsers.rst.Directive`)
+* ``sphinx.util.docutils.directive_helper()`` is deprecated
+* ``sphinx.cmdline`` is deprecated
+* ``sphinx.make_mode`` is deprecated
+* ``sphinx.locale.l_()`` is deprecated
+* #2157: helper function ``warn()`` for HTML themes is deprecated
+* ``app.override_domain()`` is deprecated
+* ``app.add_stylesheet()`` is deprecated
+* ``app.add_javascript()`` is deprecated
+* ``app.import_object()`` is deprecated
+* ``app.add_source_parser()`` has changed; the *suffix* argument has been
+ deprecated
+* ``sphinx.versioning.prepare()`` is deprecated
+* ``Config.__init__()`` has changed; the *dirname*, *filename* and *tags*
+ argument has been deprecated
+* ``Config.check_types()`` is deprecated
+* ``Config.check_unicode()`` is deprecated
+* ``sphinx.application.CONFIG_FILENAME`` is deprecated
+* ``highlightlang`` directive is deprecated
+* ``BuildEnvironment.load()`` is deprecated
+* ``BuildEnvironment.loads()`` is deprecated
+* ``BuildEnvironment.frompickle()`` is deprecated
+* ``env.read_doc()`` is deprecated
+* ``env.update()`` is deprecated
+* ``env._read_serial()`` is deprecated
+* ``env._read_parallel()`` is deprecated
+* ``env.write_doctree()`` is deprecated
+* ``env._nitpick_ignore`` is deprecated
+* ``env.versionchanges`` is deprecated
+* ``env.dump()`` is deprecated
+* ``env.dumps()`` is deprecated
+* ``env.topickle()`` is deprecated
+* ``env.note_versionchange()`` is deprecated
+* ``sphinx.writers.latex.Table.caption_footnotetexts`` is deprecated
+* ``sphinx.writers.latex.Table.header_footnotetexts`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.footnotestack`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.in_container_literal_block`` is
+ deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.next_section_ids`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.restrict_footnote()`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.check_latex_elements()`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.bibitems`` is deprecated
+* ``sphinx.writers.latex.LaTeXTranslator.hlsettingstack`` is deprecated
+* ``sphinx.writers.latex.ExtBabel.get_shorthandoff()`` is deprecated
+* ``sphinx.writers.html.HTMLTranslator.highlightlang`` is deprecated
+* ``sphinx.writers.html.HTMLTranslator.highlightlang_base`` is deprecated
+* ``sphinx.writers.html.HTMLTranslator.highlightlangopts`` is deprecated
+* ``sphinx.writers.html.HTMLTranslator.highlightlinenothreshold`` is deprecated
+* ``sphinx.writers.html5.HTMLTranslator.highlightlang`` is deprecated
+* ``sphinx.writers.html5.HTMLTranslator.highlightlang_base`` is deprecated
+* ``sphinx.writers.html5.HTMLTranslator.highlightlangopts`` is deprecated
+* ``sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold`` is deprecated
+* ``sphinx.ext.mathbase`` extension is deprecated
+* ``sphinx.ext.mathbase.math`` node is deprecated
+* ``sphinx.ext.mathbase.displaymath`` node is deprecated
+* ``sphinx.ext.mathbase.eqref`` node is deprecated
+* ``sphinx.ext.mathbase.is_in_section_title()`` is deprecated
+* ``sphinx.ext.mathbase.MathDomain`` is deprecated
+* ``sphinx.ext.mathbase.MathDirective`` is deprecated
+* ``sphinx.ext.mathbase.math_role`` is deprecated
+* ``sphinx.ext.mathbase.setup_math()`` is deprecated
+* ``sphinx.directives.other.VersionChanges`` is deprecated
+* ``sphinx.highlighting.PygmentsBridge.unhighlight()`` is deprecated
+* ``sphinx.ext.mathbase.get_node_equation_number()`` is deprecated
+* ``sphinx.ext.mathbase.wrap_displaymath()`` is deprecated
+* The ``trim_doctest_flags`` argument of ``sphinx.highlighting.PygmentsBridge``
+ is deprecated
+
+For more details, see :ref:`deprecation APIs list <dev-deprecated-apis>`.
+
+Features added
+--------------
+
+1.8.0b2
+
+* #5388: Ensure frozen object descriptions are reproducible
+* #5362: apidoc: Add ``--tocfile`` option to change the filename of ToC
+
+1.8.0b1
+
+* Add :event:`config-inited` event
+* Add ``sphinx.config.Any`` to represent the config value accepts any type of
+ value
+* :confval:`source_suffix` allows a mapping fileext to file types
+* Add :confval:`author` as a configuration value
+* #2852: imgconverter: Support to convert GIF to PNG
+* ``sphinx-build`` command supports i18n console output
+* Add ``app.add_message_catalog()`` and ``sphinx.locale.get_translations()`` to
+ support translation for 3rd party extensions
+* helper function ``warning()`` for HTML themes is added
+* Add ``Domain.enumerable_nodes`` to manage own enumerable nodes for domains
+ (experimental)
+* Add a new keyword argument ``override`` to Application APIs
+* LaTeX: new key ``'fvset'`` for :confval:`latex_elements`. For
+ XeLaTeX/LuaLaTeX its default sets ``fanvyvrb`` to use normal, not small,
+ fontsize in code-blocks (refs: #4793)
+* Add :confval:`html_css_files` and :confval:`epub_css_files` for adding CSS
+ files from configuration
+* Add :confval:`html_js_files` for adding JS files from configuration
+* #4834: Ensure set object descriptions are reproducible.
+* #4828: Allow to override :confval:`numfig_format` partially. Full definition
+ is not needed.
+* Improve warning messages during including (refs: #4818)
+* LaTeX: separate customizability of :rst:role:`guilabel` and
+ :rst:role:`menuselection` (refs: #4830)
+* Add ``Config.read()`` classmethod to create a new config object from
+ configuration file
+* #4866: Wrap graphviz diagrams in ``<div>`` tag
+* viewcode: Add :event:`viewcode-find-source` and
+ :event:`viewcode-follow-imported` to load source code without loading
+* #4785: napoleon: Add strings to translation file for localisation
+* #4927: Display a warning when invalid values are passed to linenothreshold
+ option of highlight directive
+* C++:
+
+ - Add a ``cpp:texpr`` role as a sibling to ``cpp:expr``.
+ - Add support for unions.
+ - #3593, #2683: add support for anonymous entities using names staring with
+ ``@``.
+ - #5147: add support for (most) character literals.
+ - Cross-referencing entities inside primary templates is supported,
+ and now properly documented.
+ - #1552: add new cross-referencing format for ``cpp:any`` and ``cpp:func``
+ roles, for referencing specific function overloads.
+
+* #3606: MathJax should be loaded with async attribute
+* html: Output ``canonical_url`` metadata if :confval:`html_baseurl` set (refs:
+ #4193)
+* #5029: autosummary: expose ``inherited_members`` to template
+* #3784: mathjax: Add :confval:`mathjax_options` to give options to script tag
+ for mathjax
+* #726, #969: mathjax: Add :confval:`mathjax_config` to give in-line
+ configurations for mathjax
+* #4362: latex: Don't overwrite .tex file if document not changed
+* #1431: latex: Add alphanumeric enumerated list support
+* Add :confval:`latex_use_xindy` for UTF-8 savvy indexing, defaults to ``True``
+ if :confval:`latex_engine` is ``'xelatex'`` or ``'lualatex'``. (refs: #5134,
+ #5192, #5212)
+* #4976: ``SphinxLoggerAdapter.info()`` now supports ``location`` parameter
+* #5122: setuptools: support nitpicky option
+* #2820: autoclass directive supports nested class
+* Add ``app.add_html_math_renderer()`` to register a math renderer for HTML
+* Apply :confval:`trim_doctest_flags` to all builders (cf. text, manpages)
+* #5140: linkcheck: Add better Accept header to HTTP client
+* #4614: sphinx-build: Add ``--keep-going`` option to show all warnings
+* Add :rst:role:`math:numref` role to refer equations (Same as :rst:role:`eq`)
+* quickstart: epub builder is enabled by default
+* #5246: Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml
+ builder
+* #5273: doctest: Skip doctest conditionally
+* #5306: autodoc: emit a warning for invalid typehints
+* #4075, #5215: autodoc: Add :confval:`autodoc_default_options` which accepts
+ option values as dict
+
+Bugs fixed
+----------
+
+1.8.0b2
+
+* html: search box overrides to other elements if scrolled
+* i18n: warnings for translation catalogs have wrong line numbers (refs: #5321)
+* #5325: latex: cross references has been broken by multiply labeled objects
+* C++, fixes for symbol addition and lookup. Lookup should no longer break
+ in partial builds. See also #5337.
+* #5348: download reference to remote file is not displayed
+* #5282: html theme: ``pygments_style`` of theme was overridden by ``conf.py``
+ by default
+* #4379: toctree shows confusing warning when document is excluded
+* #2401: autodoc: ``:members:`` causes ``:special-members:`` not to be shown
+* autodoc: ImportError is replaced by AttributeError for deeper module
+* #2720, #4034: Incorrect links with ``:download:``, duplicate names, and
+ parallel builds
+* #5290: autodoc: failed to analyze source code in egg package
+* #5399: Sphinx crashes if unknown po file exists
+
+1.8.0b1
+
+* i18n: message catalogs were reset on each initialization
+* #4850: latex: footnote inside footnote was not rendered
+* #4945: i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks
+ to Shengjing Zhu.
+* #4983: productionlist directive generates invalid IDs for the tokens
+* #5132: lualatex: PDF build fails if indexed word starts with Unicode character
+* #5133: latex: index headings "Symbols" and "Numbers" not internationalized
+* #5114: sphinx-build: Handle errors on scanning documents
+* epub: spine has been broken when "self" is listed on toctree (refs: #4611)
+* #344: autosummary does not understand docstring of module level attributes
+* #5191: C++, prevent nested declarations in functions to avoid lookup problems.
+* #5126: C++, add missing isPack method for certain template parameter types.
+* #5187: C++, parse attributes on declarators as well.
+* C++, parse delete expressions and basic new expressions as well.
+* #5002: graphviz: SVGs do not adapt to the column width
+
+Features removed
+----------------
+
+1.8.0b1
+
+* ``sphinx.ext.pngmath`` extension
+
+Documentation
+-------------
+
+1.8.0b1
+
+* #5083: Fix wrong make.bat option for internationalization.
+* #5115: napoleon: add admonitions added by #4613 to the docs.
+
+Release 1.7.9 (released Sep 05, 2018)
+=====================================
+
+Features added
+--------------
+
+* #5359: Make generated texinfo files reproducible by sorting the anchors
+
+Bugs fixed
+----------
+
+* #5361: crashed on incremental build if document uses include directive
+
+Release 1.7.8 (released Aug 29, 2018)
+=====================================
+
+Incompatible changes
+--------------------
+
+* The type of ``env.included`` has been changed to dict of set
+
+Bugs fixed
+----------
+
+* #5320: intersphinx: crashed if invalid url given
+* #5326: manpage: crashed when invalid docname is specified as ``man_pages``
+* #5322: autodoc: ``Any`` typehint causes formatting error
+* #5327: "document isn't included in any toctree" warning on rebuild with
+ generated files
+* #5335: quickstart: escape sequence has been displayed with MacPorts' python
+
+Release 1.7.7 (released Aug 19, 2018)
+=====================================
+
+Bugs fixed
+----------
+
+* #5198: document not in toctree warning when including files only for parallel
+ builds
+* LaTeX: reduce "Token not allowed in a PDF string" hyperref warnings in latex
+ console output (refs: #5236)
+* LaTeX: suppress "remreset Warning: The remreset package is obsolete" in latex
+ console output with recent LaTeX (refs: #5237)
+* #5234: PDF output: usage of PAPER environment variable is broken since Sphinx
+ 1.5
+* LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern
+ font with XeLaTeX/LuaLateX (refs: #5251)
+* #5280: autodoc: Fix wrong type annotations for complex typing
+* autodoc: Optional types are wrongly rendered
+* #5291: autodoc crashed by ForwardRef types
+* #5211: autodoc: No docs generated for functools.partial functions
+* #5306: autodoc: ``getargspec()`` raises NameError for invalid typehints
+* #5298: imgmath: math_number_all causes equations to have two numbers in html
+* #5294: sphinx-quickstart blank prompts in PowerShell
+
+Release 1.7.6 (released Jul 17, 2018)
+=====================================
+
+Bugs fixed
+----------
+
+* #5037: LaTeX ``\sphinxupquote{}`` breaks in Russian
+* sphinx.testing uses deprecated pytest API; ``Node.get_marker(name)``
+* #5016: crashed when recommonmark.AutoStrictify is enabled
+* #5022: latex: crashed with docutils package provided by Debian/Ubuntu
+* #5009: latex: a label for table is vanished if table does not have a caption
+* #5048: crashed with numbered toctree
+* #2410: C, render empty argument lists for macros.
+* C++, fix lookup of full template specializations with no template arguments.
+* #4667: C++, fix assertion on missing references in global scope when using
+ intersphinx. Thanks to Alan M. Carroll.
+* #5019: autodoc: crashed by Form Feed Character
+* #5032: autodoc: loses the first staticmethod parameter for old styled classes
+* #5036: quickstart: Typing Ctrl-U clears the whole of line
+* #5066: html: "relations" sidebar is not shown by default
+* #5091: latex: curly braces in index entries are not handled correctly
+* #5070: epub: Wrong internal href fragment links
+* #5104: apidoc: Interface of ``sphinx.apidoc:main()`` has changed
+* #4272: PDF builds of French projects have issues with XeTeX
+* #5076: napoleon raises RuntimeError with python 3.7
+* #5125: sphinx-build: Interface of ``sphinx:main()`` has changed
+* sphinx-build: ``sphinx.cmd.build.main()`` refers ``sys.argv`` instead of given
+ argument
+* #5146: autosummary: warning is emitted when the first line of docstring ends
+ with literal notation
+* autosummary: warnings of autosummary indicates wrong location (refs: #5146)
+* #5143: autodoc: crashed on inspecting dict like object which does not support
+ sorting
+* #5139: autodoc: Enum argument missing if it shares value with another
+* #4946: py domain: rtype field could not handle "None" as a type
+* #5176: LaTeX: indexing of terms containing ``@``, ``!``, or ``"`` fails
+* #5161: html: crashes if copying static files are failed
+* #5167: autodoc: Fix formatting type annotations for tuples with more than two
+ arguments
+* #3329: i18n: crashed by auto-symbol footnote references
+* #5158: autosummary: module summary has been broken when it starts with heading
+
+Release 1.7.5 (released May 29, 2018)
+=====================================
+
+Bugs fixed
+----------
+
+* #4924: html search: Upper characters problem in any other languages
+* #4932: apidoc: some subpackage is ignored if sibling subpackage contains a
+ module starting with underscore
+* #4863, #4938, #4939: i18n doesn't handle correctly node.title as used for
+ contents, topic, admonition, table and section.
+* #4913: i18n: literal blocks in bullet list are not translated
+* #4962: C++, raised TypeError on duplicate declaration.
+* #4825: C++, properly parse expr roles and give better error messages when
+ (escaped) line breaks are present.
+* C++, properly use ``desc_addname`` nodes for prefixes of names.
+* C++, parse pack expansions in function calls.
+* #4915, #4916: links on search page are broken when using dirhtml builder
+* #4969: autodoc: constructor method should not have return annotation
+* latex: deeply nested enumerated list which is beginning with non-1 causes
+ LaTeX engine crashed
+* #4978: latex: shorthandoff is not set up for Brazil locale
+* #4928: i18n: Ignore dot-directories like .git/ in LC_MESSAGES/
+* #4946: py domain: type field could not handle "None" as a type
+* #4979: latex: Incorrect escaping of curly braces in index entries
+* #4956: autodoc: Failed to extract document from a subclass of the class on
+ mocked module
+* #4973: latex: glossary directive adds whitespace to each item
+* #4980: latex: Explicit labels on code blocks are duplicated
+* #4919: node.asdom() crashes if toctree has :numbered: option
+* #4914: autodoc: Parsing error when using dataclasses without default values
+* #4931: autodoc: crashed when handler for autodoc-skip-member raises an error
+* #4931: autodoc: crashed when subclass of mocked class are processed by
+ napoleon module
+* #5007: sphinx-build crashes when error log contains a "%" character
+
+Release 1.7.4 (released Apr 25, 2018)
+=====================================
+
+Bugs fixed
+----------
+
+* #4885, #4887: domains: Crashed with duplicated objects
+* #4889: latex: sphinx.writers.latex causes recursive import
+
+Release 1.7.3 (released Apr 23, 2018)
+=====================================
+
+Bugs fixed
+----------
+
+* #4769: autodoc loses the first staticmethod parameter
+* #4790: autosummary: too wide two column tables in PDF builds
+* #4795: Latex customization via ``_templates/longtable.tex_t`` is broken
+* #4789: imgconverter: confused by convert.exe of Windows
+* #4783: On windows, Sphinx crashed when drives of srcdir and outdir are
+ different
+* #4812: autodoc ignores type annotated variables
+* #4817: wrong URLs on warning messages
+* #4784: latex: :confval:`latex_show_urls` assigns incorrect footnote numbers if
+ hyperlinks exists inside substitutions
+* #4837: latex with class memoir Error: Font command ``\sf`` is not supported
+* #4803: latex: too slow in proportion to number of auto numbered footnotes
+* #4838: htmlhelp: The entries in .hhp file is not ordered
+* toctree directive tries to glob for URL having query_string
+* #4871: html search: Upper characters problem in German
+* #4717: latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX
+* #4459: duplicated labels detector does not work well in parallel build
+* #4878: Crashed with extension which returns invalid metadata
+
+Release 1.7.2 (released Mar 21, 2018)
+=====================================
+
+Incompatible changes
+--------------------
+* #4520: apidoc: folders with an empty __init__.py are no longer excluded from
+ TOC
+
+Bugs fixed
+----------
+
+* #4669: sphinx.build_main and sphinx.make_main throw NameError
+* #4685: autosummary emits meaningless warnings
+* autodoc: crashed when invalid options given
+* pydomain: always strip parenthesis if empty (refs: #1042)
+* #4689: autosummary: unexpectedly strips docstrings containing "i.e."
+* #4701: viewcode: Misplaced ``<div>`` in viewcode html output
+* #4444: Don't require numfig to use :numref: on sections
+* #4727: Option clash for package textcomp
+* #4725: Sphinx does not work with python 3.5.0 and 3.5.1
+* #4716: Generation PDF file with TexLive on Windows, file not found error
+* #4574: vertical space before equation in latex
+* #4720: message when an image is mismatched for builder is not clear
+* #4655, #4684: Incomplete localization strings in Polish and Chinese
+* #2286: Sphinx crashes when error is happens in rendering HTML pages
+* #4688: Error to download remote images having long URL
+* #4754: sphinx/pycode/__init__.py raises AttributeError
+* #1435: qthelp builder should htmlesca