Package: sphinx / 2.4.3-4

Metadata

Package Version Patches format
sphinx 2.4.3-4 3.0 (quilt)

Patch series

view the series file
Patch File delta Description
disable_js_version_check.diff | (download)

tests/test_theming.py | 1 1 + 0 - 0 !
1 file changed, 1 insertion(+)

 disable a test that checks versions of js libraries

no_snowballstemmer.diff | (download)

Sphinx.egg-info/requires.txt | 1 0 + 1 - 0 !
setup.py | 1 0 + 1 - 0 !
sphinx/search/da.py | 4 2 + 2 - 0 !
sphinx/search/de.py | 4 2 + 2 - 0 !
sphinx/search/es.py | 4 2 + 2 - 0 !
sphinx/search/fi.py | 4 2 + 2 - 0 !
sphinx/search/fr.py | 4 2 + 2 - 0 !
sphinx/search/hu.py | 4 2 + 2 - 0 !
sphinx/search/it.py | 4 2 + 2 - 0 !
sphinx/search/nl.py | 4 2 + 2 - 0 !
sphinx/search/no.py | 4 2 + 2 - 0 !
sphinx/search/pt.py | 4 2 + 2 - 0 !
sphinx/search/ro.py | 4 2 + 2 - 0 !
sphinx/search/ru.py | 4 2 + 2 - 0 !
sphinx/search/sv.py | 4 2 + 2 - 0 !
sphinx/search/tr.py | 4 2 + 2 - 0 !
16 files changed, 28 insertions(+), 30 deletions(-)

 replace snowballstemmer usage with pystemmer

The snowballstemmer module uses PyStemmer (bindings for libstemmer_c)
when it is available, and falls back to its own pure Python implementation
otherwise.

To avoid an extra dependency we can use PyStemmer directly.

skip_tests_network.diff | (download)

tests/test_build_latex.py | 1 1 + 0 - 0 !
tests/test_build_linkcheck.py | 2 2 + 0 - 0 !
2 files changed, 3 insertions(+)

 skip linkcheck tests that require network access

no_external_css.diff | (download)

doc/_themes/sphinx13/layout.html | 2 0 + 2 - 0 !
sphinx/themes/pyramid/layout.html | 2 0 + 2 - 0 !
2 files changed, 4 deletions(-)

 don't use google fonts to avoid privacy breach.


no_require_setuptools.diff | (download)

setup.py | 1 0 + 1 - 0 !
1 file changed, 1 deletion(-)

 remove setuptools from install_requires

It was added there because the entry points use pkg_resources module,
but it is provided in a separate package in Debian, pulling setuptools
itself is not needed.

no_external_image.diff | (download)

doc/_templates/indexsidebar.html | 1 0 + 1 - 0 !
1 file changed, 1 deletion(-)

 do not use external image in the documentation template


remove_contrib_references.diff | (download)

doc/usage/builders/index.rst | 24 0 + 24 - 0 !
sphinx/application.py | 6 0 + 6 - 0 !
sphinx/builders/html.py | 1 0 + 1 - 0 !
3 files changed, 31 deletions(-)

 remove references to sphinxcontrib modules

They are not packaged yet, and when they are, we would want to avoid
dependency loops anyway.

skip_tests_jsmath.diff | (download)

tests/test_build_html.py | 3 3 + 0 - 0 !
1 file changed, 3 insertions(+)

 skip tests that require sphinxcontrib.jsmath module


use_packaged_mathjax.diff | (download)

doc/conf.py | 1 1 + 0 - 0 !
1 file changed, 1 insertion(+)

 use packaged mathjax (for our own documentation)


skip_tests_serializinghtml.diff | (download)

tests/test_api_translator.py | 2 2 + 0 - 0 !
1 file changed, 2 insertions(+)

 skip tests that require sphinxcontrib.serializinghtml module


move_sphinxcontrib_to_extras_require.diff | (download)

setup.py | 14 8 + 6 - 0 !
1 file changed, 8 insertions(+), 6 deletions(-)

 move sphinxcontrib modules to extras_require


html5_docs.diff | (download)

sphinx/themes/basic/layout.html | 2 1 + 1 - 0 !
1 file changed, 1 insertion(+), 1 deletion(-)

 do not include xmlns attribute with html 5 doctype

shared-mime-info 1.11 and newer versions that include commit [1]
detect files that have xmlns attribute as XHTML and not HTML.

However that makes WebKitGTK use the XML parser which is more strict
than the HTML parser, and it does not allow certain symbols like <, >
and & even inside <script> tags. A script in search.html contained
such symbols, which caused parsing errors, and that caused jstests to
fail.

To fix this, update the basic template to not set xmlns attribute for
the root element if the doctype is HTML 5.

[1]: https://gitlab.freedesktop.org/xdg/shared-mime-info/-/commit/8ae13a589577e9bd

(cherry picked from commit b0ddc26ade9c97f55c034f9405cf838acf925d68)

no_evaluate_debug.diff | (download)

sphinx/registry.py | 2 1 + 1 - 0 !
1 file changed, 1 insertion(+), 1 deletion(-)

 refactor: do not evaluate debug message on calling

(cherry picked from commit f965829cd049b986beafd561e3221784d98e199d)

no_debug.diff | (download)

sphinx/util/docutils.py | 4 0 + 4 - 0 !
1 file changed, 4 deletions(-)

 fix #7343: sphinx builds has been slower since 2.4.0 on debug mode

For now, the debug log from SphinxTranslator does not help developers.
So this disable the log outputs.  Let's reconsider if we'll need it.

(cherry picked from commit 23ffd8e01c078a68a74bdd1891006368ccd5049e)

autodoc_skip_mocked.diff | (download)

sphinx/ext/autodoc/__init__.py | 5 4 + 1 - 0 !
sphinx/ext/autodoc/mock.py | 2 2 + 0 - 0 !
2 files changed, 6 insertions(+), 1 deletion(-)

 autodoc: skip mocked modules and objects

Call ``inspect.unwrap()`` for Mocked objects and modules causes
deep recursion calls. As a result, it causes slow builds.  This
skips to try documenting mocked objects on filtering members.

(cherry picked from commit 841f1c7e766d623d5c071605650bedc834480fd2)