diff options
Diffstat (limited to '')
51 files changed, 4243 insertions, 0 deletions
diff --git a/debian/.gitlab-ci.yml b/debian/.gitlab-ci.yml new file mode 100644 index 0000000..be2cea2 --- /dev/null +++ b/debian/.gitlab-ci.yml @@ -0,0 +1,7 @@ +include: + - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/salsa-ci.yml + - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/pipeline-jobs.yml + +variables: + SALSA_CI_REPROTEST_ENABLE_DIFFOSCOPE: 1 + SALSA_CI_REPROTEST_ARGS: --variations=-locales diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..e4ea627 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,2147 @@ +sphinx (5.3.0-4) unstable; urgency=medium + + [ Dmitry Shachnev ] + * Update highlight_search_terms.diff to fix race condition affecting jstest: + - Highlight all occurrences, not just the first one. + - Stop using the old search query from localstorage. + * Port jstest to the new API from webkit2gtk 2.40 (closes: #1033635, + LP: #2013095). + + [ Jeremy Bicha ] + * Set isolation-machine for sphinx-doc autopkgtest. This is needed for web + process sandbox, which is now mandatory. + * debian/tests/sphinx-doc: Set export GTK_A11Y=none. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 29 Mar 2023 11:31:27 +0300 + +sphinx (5.3.0-3) unstable; urgency=medium + + * Backport upstream patch to update tests for Pygments 2.14 + (closes: #1028621). + * Bump Standards-Version to 4.6.2, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 14 Jan 2023 14:04:03 +0400 + +sphinx (5.3.0-2) unstable; urgency=medium + + * Build with pybuild-plugin-pyproject (closes: #1025398). + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 05 Dec 2022 21:41:01 +0300 + +sphinx (5.3.0-1) experimental; urgency=medium + + * New upstream release. + * Rebase patches for the new release. + * Build-depend on flit. + * Let flit install scripts to /usr/bin and reverse symlinks. + * Update debian/dh-sphinxdoc/index. + * Remove sphinx/locale/.tx directory from python3-sphinx. + * Add a patch to highlight all search terms on search results page. + * Update numbers in debian/jstest/run-tests. + * Port jstest to GTK 4. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 25 Oct 2022 17:29:19 +0300 + +sphinx (5.1.1-1) experimental; urgency=medium + + * New upstream release. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 30 Jul 2022 10:45:51 +0300 + +sphinx (5.1.0-1) experimental; urgency=medium + + * New upstream release. + * Remove python3-importlib-metadata dependency again. + No longer needed because Debian dropped support for Python 3.9. + * Drop no_external_image.diff, indexsidebar.html has been removed. + * Refresh other patches. + * Update debian/source/lintian-overrides for Lintian pointed hints. + * Remove copyright section for no longer shipped porter.py. + * Update numbers in debian/jstest/run-tests. + * Bump python3-sphinx-tabs broken version to << 3.4.0. + * Add Adam Turner's key to debian/upstream/signing-key.asc. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 24 Jul 2022 18:35:01 +0300 + +sphinx (5.0.2-1) experimental; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + - Drop definfoenclose.diff, included in the new release. + * Use utils/babel_runner.py for compiling the translation files. + * Update debian/dh-sphinxdoc/index for the new version: + - Add _sphinx_javascript_frameworks_compat.js. + - Bump min-version to 5.0 for JS files that changed significantly. + * Parse the whole Search.setIndex argument as JSON. + * Add Sphinx.egg-info/entry_points.txt to debian/clean. + * Run JS tests with a real GTK window. Searchtools.js relies on setTimeout + to load every new search result, and WebKitGTK sets timeout to 1 second + after 5th request when the page is invisible. We have many search results, + so we get a timeout error unless we make it visible. + * Update numbers in debian/jstest/run-tests. + * Update debian/copyright. + * Bump Standards-Version to 4.6.1, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 16 Jun 2022 20:56:55 +0300 + +sphinx (4.5.0-4) unstable; urgency=medium + + [ Dmitry Shachnev ] + * Backport upstream patch to stop using @definfoenclose texinfo command + (closes: #996151). + * Update jstest to use WebKit2 4.1. + + [ Simon Chopin ] + * Use full JSON unescaping in file names + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 16 Jun 2022 19:37:25 +0300 + +sphinx (4.5.0-3) unstable; urgency=medium + + * Hotfix: move python3-importlib-metadata from Suggests to Depends. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 15 Apr 2022 19:31:16 +0300 + +sphinx (4.5.0-2) unstable; urgency=medium + + * Depend on python3-importlib-metadata, needed because we still support + Python 3.9 (closes: #1009382, #1009434, #1009445). + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 15 Apr 2022 14:21:33 +0300 + +sphinx (4.5.0-1) unstable; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + * dh_sphinxdoc: Unescape unicode in file names (closes: #1008504). + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 02 Apr 2022 16:32:51 +0300 + +sphinx (4.4.0-1) experimental; urgency=medium + + * New upstream release. + * Remove debian/py3dist-overrides. Sphinx no longer uses pkg_resources. + * Amend intersphinx_local.diff to remove cross-references to ReadTheDocs. + * Refresh other patches. + * Update numbers in debian/jstest/run-tests. + * Add python3-setuptools to tests dependencies. + * Bump upstream copyright years in debian/copyright. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 18 Jan 2022 14:17:46 +0300 + +sphinx (4.3.2-1) unstable; urgency=medium + + * New upstream release. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 19 Dec 2021 15:55:13 +0300 + +sphinx (4.3.1-2) unstable; urgency=medium + + * dh_sphinxdoc: + - Stop taking Python 2 version of alabaster into account. + - Generate dependency on libjs-sphinxdoc ≥ 4.3 for searchtools.js. + - Loosen regex to detect searchindex.js loading (closes: #1001521). + * Add a patch to make searchtools.js support pre-4.3 search indexes + (closes: #1001509). + * Add Sphinx.egg-info/requires.txt and .mo files to debian/clean. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 12 Dec 2021 21:44:32 +0300 + +sphinx (4.3.1-1) unstable; urgency=medium + + * New upstream release. + * Drop reproducible_restify.diff, applied in the new release. + * Refresh debian/patches/skip_tests_jsmath.diff. + * Update numbers in debian/jstest/run-tests. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 27 Nov 2021 19:22:23 +0300 + +sphinx (4.2.0-5) unstable; urgency=medium + + * Remove Built-Using field from sphinx-doc. We do not incorporate any parts + of other source packages during sphinx-doc build. + * Run wrap-and-sort. + * Add a patch to make util.typing.restify sanitize unreproducible output + (closes: #996948). Thanks Chris Lamb! + * Update debian/source/lintian-overrides for Lintian 2.109. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 23 Oct 2021 14:21:42 +0300 + +sphinx (4.2.0-4) unstable; urgency=medium + + * Team upload. + * Add new breaks on sphinx-tabs << 3.2.0 + + -- Michael R. Crusoe <crusoe@debian.org> Sun, 10 Oct 2021 13:20:27 +0200 + +sphinx (4.2.0-3) unstable; urgency=medium + + * Team upload. + * Add new breaks on nbsphinx << 0.8.7 + * d/control: make use of ${perl:Depends} in sphinx-common and + ${sphinxdoc:Built-Using} in sphinx-doc + * Add salsa-ci file (routine-update) + + -- Michael R. Crusoe <crusoe@debian.org> Sat, 09 Oct 2021 09:21:02 +0200 + +sphinx (4.2.0-2) unstable; urgency=medium + + * Upload to unstable (closes: #994114). + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 25 Sep 2021 21:33:30 +0300 + +sphinx (4.2.0-1) experimental; urgency=medium + + * New upstream release. + * Refresh debian/patches/remove_contrib_references.diff. + * Update numbers in debian/jstest/run-tests for the new release. + * Bump Standards-Version to 4.6.0, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 12 Sep 2021 15:43:21 +0300 + +sphinx (4.1.2-1) experimental; urgency=medium + + * New upstream release. + * Refresh debian/patches/skip_tests_network.diff. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 27 Jul 2021 20:24:27 +0300 + +sphinx (4.1.1-1) experimental; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + * debian/jstest/run-tests: Update number of highlights for “examples”. + * Break python3-sphinxcontrib.serializinghtml < 1.1.5. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 15 Jul 2021 13:59:17 +0300 + +sphinx (4.0.3-1) experimental; urgency=medium + + * New upstream release. + * dh_sphinxdoc: Use the last definition of DOCUMENTATION_OPTIONS, if + there are several of them. + * Refresh move_sphinxcontrib_to_extras_require.diff. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 10 Jul 2021 13:35:22 +0300 + +sphinx (4.0.2-1) experimental; urgency=medium + + * New upstream release. + * Refresh move_sphinxcontrib_to_extras_require.diff. + * Revert the old build path in debian/sphinx-common.manpages. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 21 May 2021 20:15:43 +0300 + +sphinx (4.0.1-1) experimental; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + * Bump required python3-docutils version to 0.14. + * Add tex-gyre to Build-Depends, Suggests and autopkgtest dependencies. + * Update debian/sphinx-common.manpages for the new build path. + * Update numbers in debian/jstest/run-tests for the new release. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 10 May 2021 21:35:39 +0300 + +sphinx (3.5.4-2) unstable; urgency=medium + + * dh_sphinxdoc: Use the last definition of DOCUMENTATION_OPTIONS, if + there are several of them. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 21 Aug 2021 22:05:35 +0300 + +sphinx (3.5.4-1) experimental; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 13 Apr 2021 15:16:49 +0300 + +sphinx (3.5.3-1) experimental; urgency=medium + + * New upstream release. + * Merge 3.4.3-2 upload from unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 20 Mar 2021 21:17:18 +0300 + +sphinx (3.5.2-1) experimental; urgency=medium + + * New upstream release. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 06 Mar 2021 20:10:53 +0300 + +sphinx (3.5.1-2) experimental; urgency=medium + + * Move the minified stemmer JS files to the correct location. + * Document the license of stemmer JS files in debian/copyright. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 23 Feb 2021 20:08:47 +0300 + +sphinx (3.5.1-1) experimental; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + * Override Lintian source-is-missing warnings about stemmer JS files. + * Add debian/upstream/metadata file. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 16 Feb 2021 20:11:51 +0300 + +sphinx (3.4.3-2) unstable; urgency=medium + + * dh_sphinxdoc: Fix the script tag regex used in singlehtml detection + (closes: #983858). + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 08 Mar 2021 21:40:25 +0300 + +sphinx (3.4.3-1) unstable; urgency=medium + + * New upstream release. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 08 Jan 2021 20:11:19 +0300 + +sphinx (3.4.2-1) unstable; urgency=medium + + * New upstream release. + * Bump upstream copyright years in debian/copyright. + * Update debian/watch to version 4. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 04 Jan 2021 20:17:45 +0300 + +sphinx (3.4.1-1) unstable; urgency=medium + + * New upstream release. + * Update debian/copyright. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 26 Dec 2020 11:47:43 +0300 + +sphinx (3.4.0-1) experimental; urgency=medium + + * New upstream release. + * Rebase patches for the new release. + * Use packaged inventory from python-requests-doc. + * Stop exporting http_proxy for the python3-sphinx autopkgtest. + It breaks linkcheck tests which start a local HTTP server thread. + - Do not skip test_raises_for_invalid_status anymore. + - Skip test_build_sphinx_return_nonzero_status. It fails if trying to + access localhost.unexistentdomain results in 503 Server Error from + the proxy server. + * Bump Standards-Version to 4.5.1, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 22 Dec 2020 15:16:26 +0300 + +sphinx (3.3.1-1) unstable; urgency=medium + + * New upstream release. + * Drop pygments_2.7.diff, included in the new release. + * Refresh other patches. + * Remove python3-sphinx.lintian-overrides, not needed with Lintian 2.92. + * Add test_raises_for_invalid_status to skip_tests_network.diff. + * Replace no_require_setuptools.diff with a debian/py3dist-overrides file. + That is a more compact way to specify that we do not need setuptools. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 12 Nov 2020 20:05:30 +0300 + +sphinx (3.2.1-2) unstable; urgency=medium + + [ Dmitry Shachnev ] + * Drop no_snowballstemmer.diff and use python3-snowballstemmer as + upstream does, now that it is properly packaged. + * Backport upstream commit to make the tests pass with Pygments 2.7. + + [ Ondřej Nový ] + * d/control: Update Maintainer field with new Debian Python Team + contact address. + * d/control: Update Vcs-* fields with new Debian Python Team Salsa + layout. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 10 Oct 2020 20:13:16 +0300 + +sphinx (3.2.1-1) unstable; urgency=medium + + * New upstream release. + - Fixes crashes when documenting extension modules (closes: #966983). + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 14 Aug 2020 14:06:07 +0300 + +sphinx (3.2.0-1) unstable; urgency=medium + + [ Debian Janitor ] + * Set field Upstream-Name in debian/copyright. + * Fix day-of-week for changelog entry 0.6.1-1. + + [ Dmitry Shachnev ] + * Merge 2.4.3-5 upload from unstable. + * Make dh_sphinxdoc generate stricter dependencies on libjs-sphinxdoc. + * New upstream release. + * Refresh patches for the new release. + * Update numbers in debian/jstest/run-tests for the new release. + * Remove python3-typed-ast from Build-Depends and tests dependencies, + now that we no longer need to test with Python 3.7. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 09 Aug 2020 14:41:55 +0300 + +sphinx (3.1.2-1) experimental; urgency=medium + + * Bump python3-breathe Breaks to 4.15 (closes: #963653). + * New upstream release. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 06 Jul 2020 21:57:28 +0300 + +sphinx (3.1.1-1) experimental; urgency=medium + + * New upstream release. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 21 Jun 2020 14:26:39 +0300 + +sphinx (3.1.0-1) experimental; urgency=medium + + * New upstream release. + * Refresh patches for the new release. + * Specify Rules-Requires-Root: no. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 09 Jun 2020 20:27:18 +0300 + +sphinx (3.0.4-1) experimental; urgency=medium + + * New upstream release. + * Drop patches, included in the new release: + - html5_docs.diff + - no_evaluate_debug.diff + - no_debug.diff + - autodoc_skip_mocked.diff + * Refresh and rebase other patches. + * Update numbers in debian/jstest/run-tests for the new release. + * Update the package description. + - Recommend build-depending on the new sphinx virtual package. + * Add a patch to use packaged intersphinx inventory for Python API. + - Also make sphinx-doc depend on python3-doc. + * Update to debhelper compat level 13. + * Stop excluding test_websupport.py which no longer exists. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 02 Jun 2020 13:08:36 +0300 + +sphinx (2.4.3-5) unstable; urgency=medium + + * dh_sphinxdoc improvements: + - Make defer attribute of searchindex.js optional (closes: #966979). + - Allow for trailing whitespace in script src attribute, it is allowed + by the HTML specification. + - Add support for symlinking language_data.js for English (see #964013). + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 04 Aug 2020 21:52:28 +0300 + +sphinx (2.4.3-4) unstable; urgency=medium + + * Update autodoc_skip_mocked.diff to use safe_getattr instead of plain + getattr (based on upstream PR #7520). See #959558. + * Update the package description. + - Recommend build-depending on the new sphinx virtual package. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 03 Jun 2020 11:32:20 +0300 + +sphinx (2.4.3-3) unstable; urgency=medium + + * Break python3-sphinx-celery < 2.0.0 (closes: #958985). + * Export http_proxy=http://127.0.0.1:9/ when running the autopkgtest. + * Make autodoc skip mocked objects (closes: #959558). + * Stop using alternatives, ship /usr/bin/sphinx-* symlinks directly. + * Make python3-sphinx provide sphinx virtual package (see #961206). + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 28 May 2020 11:51:15 +0300 + +sphinx (2.4.3-2) unstable; urgency=medium + + * Simplify debian/patches/html5_docs.diff for the new release. + * Break python3-breathe < 4.13 (closes: #955569). + * Backport two upstream patches to fix performance issues because of + debug calls. + * Clean up debian/clean, remove files no longer present upstream. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 13 Apr 2020 16:07:18 +0300 + +sphinx (2.4.3-1) experimental; urgency=medium + + * New upstream release. + * Update to debhelper compat level 12. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 26 Feb 2020 12:03:03 +0300 + +sphinx (2.4.1-1) experimental; urgency=medium + + [ Dmitry Shachnev ] + * New upstream release. + * Refresh patches for the new release. + * Depend on python3-typed-ast to make the tests pass with Python 3.7. + * dh_sphinxdoc: Add support for script tags without type="text/javascript". + * dh_sphinxdoc: Do not warn about sidebar.js file. + * Update numbers in debian/jstest/run-tests for the new release. + + [ Michael R. Crusoe ] + * Mark the -doc and -common binary packages as Multi-Arch: foreign. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 17 Feb 2020 11:59:57 +0300 + +sphinx (2.3.1-1) experimental; urgency=medium + + [ Christoph Berg ] + * New upstream version 2.2.0. + * Remove obsolete patches: no_require_websupport.diff, + python2_test_get_module_source.diff, reproducible_download.diff, + docutils_0.15.diff, remove_websupport_assets.diff. + + [ Dmitry Shachnev ] + * New upstream version 2.3.1 (closes: #944913). + * Drop no_spaces_in_hyphenated_words.diff, applied in the new release. + * Drop debian/patches/python2_tests_import_hack.diff, this version of + Sphinx no longer supports Python 2. + * Refresh other patches. + * Drop Python 2 support from packaging. + * Update dependencies according to upstream setup.py: + - Bump required docutils version to 0.12. + - Bump required requests version to 2.5.0. + - Remove six from dependencies. + - Remove mock from tests dependencies. + * Patch out references to sphinxcontrib modules. + * Skip tests that require sphinxcontrib.jsmath module. + * Update dh_sphinxdoc for the new searchindex.js loading scheme. + * Use packaged MathJax for sphinx-doc. + * Build-Depend on and suggest fonts-freefont. The LaTeX writer now uses + this font for xelatex and lualatex. + * Update numbers in debian/jstest/run-tests for the new release. + * Skip tests that require sphinxcontrib.serializinghtml module (they were + run only during autopkgtest). + * Move sphinxcontrib modules to extras_require. + * Move python3-lib2to3 from Depends to Suggests. + * Update the Homepage field to use https. + * Bump Standards-Version to 4.5.0, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 07 Feb 2020 14:15:40 +0300 + +sphinx (1.8.5-9) unstable; urgency=medium + + * Drop two python2 patches, no longer needed. + * jstest: Enable writing console messages to stdout. + * Make Sphinx' documentation use HTML 5 instead of XHTML, to fix WebKitGTK + parsing errors with shared-mime-info ≥ 0.11 (LP: #1871610). + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 09 Apr 2020 15:36:45 +0300 + +sphinx (1.8.5-8) unstable; urgency=medium + + * Drop Python 2 support; Closes: #938528 + + -- Sandro Tosi <morph@debian.org> Fri, 27 Mar 2020 12:40:09 -0400 + +sphinx (1.8.5-7) unstable; urgency=medium + + * Make the autopkgtest depend on python3-all, and use py3versions -s + instead of -i. + * Update to debhelper compat level 12. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 20 Mar 2020 14:33:53 +0300 + +sphinx (1.8.5-6) unstable; urgency=medium + + * Update dh_sphinxdoc for the new searchindex.js loading scheme + (closes: #953567). + * Bump Standards-Version to 4.5.0, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 14 Mar 2020 12:11:42 +0300 + +sphinx (1.8.5-5) unstable; urgency=medium + + * Make sphinx-common provide dh-sequence-sphinxdoc (closes: #946899). + * Drop python-sphinxcontrib.websupport from autopkgtest dependencies, + to allow for its removal. + * Backport upstream patch to fix crashes with docutils 0.16. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 12 Jan 2020 17:01:00 +0300 + +sphinx (1.8.5-4) unstable; urgency=medium + + * Remove extra underscore character from debian/sphinx-doc.doc-base. + * Run sphinx-doc autopkgtest on all architectures again (bug #931807 has + been fixed). + * Stop installing static files for websupport. These files are already + shipped by python[3]-sphinxcontrib.websupport, and there is no need to + have them in all -doc packages that do not use websupport. + * Backport upstream patch to fix spaces being added to hyphenated words + with text writer (closes: #944331). + * Add some generated files to debian/clean. + * Bump Standards-Version to 4.4.1, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 05 Dec 2019 14:18:02 +0300 + +sphinx (1.8.5-3) unstable; urgency=medium + + [ Ondřej Nový ] + * Use debhelper-compat instead of debian/compat. + + [ Dmitry Shachnev ] + * Suggest texlive-plain-generic instead of texlive-generic-extra. + The latter package is no longer built, and iftex.sty is now shipped by + the former package. + * Backport upstream patch to fix test failure with docutils 0.15. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 16 Aug 2019 22:08:42 +0300 + +sphinx (1.8.5-2) unstable; urgency=medium + + * Update debian/.gitlab-ci.yml to use salsa-pipeline. + * Add a patch to make generated download links reproducible. + * Skip sphinx-doc autopkgtest on ppc64el and s390x (because of #931807). + Based on a change applied by Dimitri John Ledkov in Ubuntu. + * Bump Standards-Version to 4.4.0, no changes needed. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 14 Jul 2019 17:40:25 +0300 + +sphinx (1.8.5-1) experimental; urgency=medium + + * New upstream release. + * Drop reproducible_graphviz.diff, a better fix was applied upstream. + * Refresh skip_tests_network.diff. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 10 Mar 2019 18:40:56 +0300 + +sphinx (1.8.4-1) unstable; urgency=medium + + * New upstream release. + * Ensure the graphviz filenames are reproducible (closes: #921513). + * Bump year in debian/copyright. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 16 Feb 2019 16:55:01 +0300 + +sphinx (1.8.3-2) unstable; urgency=medium + + * Bump Standards-Version to 4.3.0, no changes needed. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 26 Jan 2019 12:42:25 +0300 + +sphinx (1.8.3-1) experimental; urgency=medium + + * New upstream release. + * Drop language_data.js.diff, applied upstream. + * Refresh skip_tests_network.diff. + * Add a patch to make test_get_module_source() pass on Python 2. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 09 Jan 2019 19:36:31 +0300 + +sphinx (1.8.2-1) experimental; urgency=medium + + * New upstream release. + * Drop mathjax_on_demand.diff, applied upstream. + * Backport upstream patch to make search work with custom templates, by + moving language data into a separate JS file (language_data.js.diff). + * Adapt dh_sphinxdoc for the introduction of language_data.js. + * Override Lintian false positive warning about todo.py extension. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 11 Nov 2018 14:53:05 +0300 + +sphinx (1.8.1-1) experimental; urgency=medium + + * New upstream release. + * Drop patches, applied upstream: + - 0005-Fix-testsuite-to-not-rely-on-return-types.patch + - 0007-Fix-spelling-error-in-manpage.patch + - 0008-Call-object_description-recursively-for-dict-keys-an.patch + - 0009-Ensure-the-set-object-description-is-reproducible.patch + * Refresh and rebase the other patches. + * Drop numbers from the remaining patches, use consistent naming. + * Do not copy .doctrees/ during docs build, it is now in source tree. + * Make test_math_compat pass with Python 2, by adding sphinx.ext.mathbase + toplevel import (python2_tests_import_hack.diff). + * Add a patch to load MathJax.js only on demand (mathjax_on_demand.diff). + * Update debian/clean to clean .doctrees, .pytest_cache and tests/build. + * dh_sphinxdoc: + - Remove mention of “non-English searchtools.js”, all language-specific + stuff is now in documentation_options.js. + - Warn about missing SEARCH_LANGUAGE_STOP_WORDS. + * Update numbers in debian/jstest/run-tests for the new release. + * Remove obsolete section from debian/copyright. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 29 Oct 2018 16:41:33 +0300 + +sphinx (1.7.9-1) unstable; urgency=medium + + * New upstream bugfix release. + * Drop 0012-Make-generated-texinfo-files-reproducible-by-sorting.patch, + applied upstream. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 06 Sep 2018 13:11:38 +0300 + +sphinx (1.7.8-1) unstable; urgency=medium + + * New upstream bugfix release. + * Refresh 0009-Ensure-the-set-object-description-is-reproducible.patch. + * Make generated texinfo files reproducible (closes: #907352). + * Bump Standards-Version to 4.2.1, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 31 Aug 2018 14:31:03 +0300 + +sphinx (1.7.7-1) unstable; urgency=medium + + * New upstream bugfix release. + * Refresh patches for the new release. + * Directly use PyStemmer for non-English search (without the wrapper). + * Bump Standards-Version to 4.2.0. + * Pass --verbose to pytest, as now required by Policy §4.9. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 25 Aug 2018 11:14:54 +0300 + +sphinx (1.7.6-1) unstable; urgency=medium + + * New upstream bugfix release. + * Drop patches, applied upstream: + - 0011-Fix-5022-latex-crashed-with-docutils-package-provide.patch + - 0012-Fix-5048-crashed-with-numbered-toctree.patch + * Refresh other patches. + * Run “wrap-and-sort”. + * Recommend make (closes: #903260). + * Add back PYTHONWARNINGS=d, the pytest warnings have been fixed. + * Add a patch to remove use of external image from img.shields.io in + the documentation template. + * Bump Standards-Version to 4.1.5, no changes needed. + * Rely on dh_python{2,3} for generating most of package dependencies. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 08 Jul 2018 16:22:44 +0300 + +sphinx (1.7.5-6) unstable; urgency=medium + + * Export LC_ALL=C.UTF-8 to make the build pass on the buildds. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 05 Jul 2018 14:26:07 +0300 + +sphinx (1.7.5-5) unstable; urgency=medium + + * dh_sphinxdoc: Generate versioned dependencies on sphinx-rtd-theme-common. + * Switch to dh sequencer and pybuild buildsystem. + * Stop setting PYTHONWARNINGS=d. There are too many deprecation warnings + coming from pytest. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 05 Jul 2018 13:00:27 +0300 + +sphinx (1.7.5-4) experimental; urgency=medium + + * Use the alternatives mechanism for managing scripts. + * Prefer Python 3 versions of the scripts (closes: #898009). + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 23 Jun 2018 00:45:15 +0300 + +sphinx (1.7.5-3) unstable; urgency=medium + + * Backport upstream patch to fix crash with numbered toctrees + (closes: #901769, thanks Robin Jarry for the bug report). + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 18 Jun 2018 15:28:44 +0300 + +sphinx (1.7.5-2) unstable; urgency=medium + + * dh_sphinxdoc: Fix for templates that do not use documentation_options.js + (closes: #901662, thanks Rebecca N. Palmer for the bug report). + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 16 Jun 2018 21:54:03 +0300 + +sphinx (1.7.5-1) unstable; urgency=medium + + [ Ondřej Nový ] + * d/control: Remove ancient X-Python-Version field + * d/control: Remove ancient X-Python3-Version field + + [ Dmitry Shachnev ] + * New upstream bugfix release. + * Backport upstream patch to support standalone roman module. + * dh_sphinxdoc: Support url_root in the new data-url_root attribute. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 15 Jun 2018 17:45:33 +0300 + +sphinx (1.7.4-1) unstable; urgency=medium + + * New upstream bugfix release. + - Fixed crash with duplicated objects (closes: #896897). + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 25 Apr 2018 20:47:00 +0300 + +sphinx (1.7.3-1) unstable; urgency=medium + + * New upstream bugfix release. + * Refresh debian/patches/0003-skip_tests_network.diff. + * Set PYTHONPATH to $(CURDIR) when building our own documentation, + to make sure we are using the local version of Sphinx code. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 23 Apr 2018 11:09:06 +0300 + +sphinx (1.7.2-4) unstable; urgency=medium + + [ Ondřej Nový ] + * d/tests: Use AUTOPKGTEST_TMP instead of ADTTMP + + [ Dmitry Shachnev ] + * Update autopkgtests to work with Sphinx 1.7 (closes: #895854). + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 18 Apr 2018 17:35:47 +0300 + +sphinx (1.7.2-3) unstable; urgency=medium + + * Remove setuptools from install_requires, it is not needed on Debian + (closes: #895738). + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 15 Apr 2018 21:43:18 +0300 + +sphinx (1.7.2-2) unstable; urgency=medium + + * Make python-sphinx depend on python-typing (closes: #895727). + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 15 Apr 2018 13:08:26 +0300 + +sphinx (1.7.2-1) unstable; urgency=medium + + [ Chris Lamb ] + * New upstream release. + * Pass -vv to pytest when running the testsuite. + * Patches: + - Apply patch series from https://github.com/sphinx-doc/sphinx/pull/4834 to + make the set output reproducible. (Closes: #895553) + - Don't use Google Fonts to avoid privacy breach. + - Fix "arbitary" spelling error in sphinx-quickstart(1) manpage. + - Fix testsuite to not rely on return types. + - Refresh and renumber all patches. + * Bump Standards-Version to 4.1.4. + * Add myself to Uploaders. + + [ Dmitry Shachnev ] + * Merge 1.6.7-2 upload from experimental to unstable. + + -- Chris Lamb <lamby@debian.org> Sat, 14 Apr 2018 19:32:39 +0100 + +sphinx (1.7.1-1) experimental; urgency=medium + + * New upstream release (closes: #890581). + - No longer bundles a copy of pgen2 (closes: #609485). + * Drop reproducible_epub.diff and text_section_numbering.diff, applied + in the new release. + * Refresh and rebase other patches. + * Build-depend and depend on python[3]-packaging. + * Update commands to build docs and run tests. + * All scripts are now setuptools entrypoints, update the code accordingly. + * Update debian/copyright. + * dh_sphinxdoc: Support standalone documentation_options.js files. + * Update numbers in debian/jstest/run-tests for the new release. + * Use upstream sphinx-autogen(1) manpage. + * Set PYTHONPATH to current directory when running the tests. + * Set PYTHONPATH when running the install-js script. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 04 Mar 2018 12:20:20 +0300 + +sphinx (1.6.7-2) unstable; urgency=medium + + * Make python3-sphinx depend on python3-distutils (closes: #893620). + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 22 Mar 2018 18:07:32 +0300 + +sphinx (1.6.7-1) unstable; urgency=medium + + * New upstream bugfix release. + * Update Vcs fields for migration to salsa.debian.org. + * Update debhelper compat level to 11. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 11 Feb 2018 22:08:38 +0300 + +sphinx (1.6.6-2) unstable; urgency=medium + + * Backport upstream patch to add optional section numbering in plain + text output (closes: #872868). + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 24 Jan 2018 21:51:28 +0300 + +sphinx (1.6.6-1) unstable; urgency=medium + + * New upstream release (closes: #881923). + * Drop reproducible_dicts.diff and reproducible_htmlhelp.diff, applied + in the new release. + * Refresh other patches. + * Remove trailing whitespace from debian/control and debian/rules. + * Rewrite debian/copyright using the machine-readable format 1.0. + * Bump Standards-Version to 4.1.3, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 11 Jan 2018 16:07:07 +0300 + +sphinx (1.6.5-4) unstable; urgency=medium + + * Change python3.6-2to3 dependencies to python3-lib2to3. + * Backport upstream reproducibility fix for htmlhelp and qthelp builders + (reproducible_htmlhelp.diff; closes: #884010). + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 28 Dec 2017 14:04:30 +0300 + +sphinx (1.6.5-3) unstable; urgency=medium + + * Make python3-sphinx depend on python3.6-2to3, where lib2to3 is shipped + since python3.6 3.6.4~rc1-2. It will be replaced with a more generic + dependency later. + * Also build-depend on python3.6-2to3, to make the tests pass. + * Bump Standards-Version to 4.1.2, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 15 Dec 2017 17:03:53 +0300 + +sphinx (1.6.5-2) unstable; urgency=medium + + * Backport two upstream patches to improve builds reproducibility: + - reproducible_dicts.diff to sort dictionary keys (closes: #877637). + - reproducible_epub.diff to make EPUB generation reproducible. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 29 Oct 2017 19:12:40 +0300 + +sphinx (1.6.5-1) unstable; urgency=medium + + * New upstream release. + * Drop cpp_no_assert and sourcelink_suffix_fallback.diff, applied in the + new release. + * dh_sphinxdoc: In singlehtml check, consider only HTML files that use + doctools.js (closes: #872863). + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 23 Oct 2017 12:21:59 +0300 + +sphinx (1.6.4-2) unstable; urgency=medium + + * Add a note that dh_sphinxdoc does not actually build the documentation + to its manpage. + * Backport upstream patch to fix wrong AssertionError in C++ domain + (cpp_no_assert.diff; closes: #877014). + * Backport upstream patch to make searchtools.js work with pre-Sphinx 1.5 + templates (sourcelink_suffix_fallback.diff). + * Update dh_sphinxdoc for the above change: there is no more need to error + about missing SOURCELINK_SUFFIX. + * Bump Standards-Version to 4.1.1, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 04 Oct 2017 11:53:44 +0700 + +sphinx (1.6.4-1) unstable; urgency=medium + + * New upstream release. + - Fixes incorrect return status in sphinx-build (closes: #876048). + * Drop upstream_fix_crash_on_parallel_build.diff, applied upstream. + * dh_sphinxdoc: Turn warning about missing SOURCELINK_SUFFIX to an error. + * Change sphinx-common trigger from interest to interest-noawait. + * Bump Standards-Version to 4.1.0, no changes needed. + * Use pkg-info.mk to retrieve the upstream version number. + * Use python3 to build our own documentation. + * Add support for nodoc build profile. + * Add python3-sphinxcontrib.websupport to build-dependencies for docs. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 26 Sep 2017 17:47:54 +0300 + +sphinx (1.6.3-2) unstable; urgency=medium + + * Move sphinxcontrib-websupport from requirements to extras_require + in setuptools metadata (no_require_websupport.diff). + * Backport upstream patch to fix crash with new python2.7 + (upstream_fix_crash_on_parallel_build.diff; closes: #869098). + * dh_sphinxdoc: Add support for singlehtml builds (closes: #872863). + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 17 Sep 2017 20:52:27 +0300 + +sphinx (1.6.3-1) experimental; urgency=medium + + * New upstream release (closes: #866789). + * Update dependencies for the new release. + - Drop python[3]-whoosh and python[3]-sqlalchemy build-dependencies. + They were only needed for websupport tests, now skipped (see below). + - Add build-dependency on python-typing (Python 2 only). + - Add suggestion on latexmk, it is now used for LaTeX builds. + - Add build-dependency and suggestion on imagemagick-6.q16 and + librsvg2-bin, needed for imgconverter extension. + * Update autopkgtest dependencies. + - Add python[3]-sphinxcontrib.websupport. + - Add python[3]-sqlalchemy. + * Disable one more test that needs network in skip_tests_network.diff. + * Move libjs-sphinxdoc package to javascript section. + * Update numbers in debian/jstest/run-tests for the new release. + * Update debian/copyright from upstream LICENSE and AUTHORS files. + * Skip running websupport tests during build, to avoid build-dependency + loop with sphinxcontrib-websupport. + * Remove useless FIXME comment from debian/rules. + * Do not run tests with --verbose flag during build, to make the output + easier to read. + * Document the new --imported-members option in sphinx-autogen manpage. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 06 Aug 2017 15:13:24 +0300 + +sphinx (1.5.6-2) unstable; urgency=medium + + * Drop Patch-Name headers, not needed with gbp-pq. + * Bump Standards-Version to 4.0.0, no changes needed. + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 09 Jul 2017 12:05:28 +0300 + +sphinx (1.5.6-1) experimental; urgency=medium + + * New upstream bugfix release. + * Update jstests for compatibility with WebKitGTK+ 2.16.2. + Now the title property can be no longer than 1000 characters, so we + cannot fetch the whole page using it. Instead, we compute the needed + numbers with JavaScript and then fetch them using the title property. + * Update debian/copyright for upstream LICENSE change. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 15 May 2017 11:31:42 +0300 + +sphinx (1.5.5-1) experimental; urgency=medium + + * New upstream release. + * dh_sphinxdoc: Use a better message for missing sourcelink_suffix, and + downgrade this error to a warning. + * Clean some files which erroneously got into the upstream tarball. + * Sync debian/copyright with upstream AUTHORS file. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 06 Apr 2017 23:27:29 +0300 + +sphinx (1.5.3-1) experimental; urgency=medium + + * New upstream release. + * Build-depend on texlive-luatex, to make xetex tests not be skipped. + * Convert from git-dpm to patches unapplied format. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 15 Mar 2017 12:37:21 +0300 + +sphinx (1.5.2-2) experimental; urgency=medium + + * dh_sphinxdoc: Properly detect sourcelink_suffix and use it when looking + for source and HTML files. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 24 Jan 2017 12:42:06 +0300 + +sphinx (1.5.2-1) experimental; urgency=medium + + * New upstream release. + - Drop fix_xapian_search.diff, applied upstream. + - Rebase other patches for test system changes to pytest. + * Bump python[3]-requests dependency to 2.4.0. + * Switch from nose to pytest, following upstream. + * Update one number in debian/jstest/run-tests for the new release. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 22 Jan 2017 19:45:18 +0300 + +sphinx (1.5.1-1) experimental; urgency=medium + + * New upstream release. + * Drop docutils_0.13.diff, applied upstream. + * Rebase other patches. + * Bump X-Python-Version to 2.7 and X-Python3-Version to 3.4, following + upstream. + * Depend on python[3]-requests and build-depend on python[3]-html5lib. + * Build-depend and recommend python-enum34 (for autodoc extension). + * Drop texlive-generic-extra dependency, iftex is no longer used. + * Stop unbundling fncychap.sty (no longer bundled), iftex.sty and + newfloat.sty (no longer used). + * Skip test_meta_keys_are_handled_for_language_de, fails without snowball. + * Backport upstream change to fix Xapian search adapter crashes + (fix_xapian_search.diff). + * Skip tests that require internet access (skip_tests_network.diff). + * Update dh_sphinxdoc for upstream changes to document extensions. + * Update numbers in debian/jstest/run-tests for the new release. + * Move the new templates directory to sphinx-common package. + * Move the non-minified JS files to sphinx-common package. + * Add allow-stderr restriction for the sphinx-doc autopkgtest. + * Clean and do not install the sphinx/locale/.tx/config file. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 23 Dec 2016 11:34:31 +0300 + +sphinx (1.4.9-2) unstable; urgency=medium + + * Backport upstream patch to add compatibility with docutils 0.13 + (docutils_0.13.diff). + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 11 Dec 2016 11:42:43 +0300 + +sphinx (1.4.9-1) unstable; urgency=medium + + * New upstream bugfix release (closes: #846149). + * Drop fix_autodoc_new_python.diff, applied upstream. + * Remove unwanted file sphinx/locale/.DS_Store in clean target. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 29 Nov 2016 13:37:31 +0300 + +sphinx (1.4.8-2) unstable; urgency=medium + + * Relax the check in dh_sphinxdoc to allow different locations of + searchindex.js file (closes: #841141). + * Sort $(scripts) variable in Makefile, to fix a reproducibility issue. + * Backport upstream patch to fix autodoc failures with new Python 3.5 + and Python 3.6 snapshots (fix_autodoc_new_python.diff). Fixes FTBFS. + * Drop build-dependencies on python[3]-xapian (closes: #842903). + * Add more tests dependencies to the autopkgtests. + * Update dh_sphinxdoc manpage for the latest changes (closes: #836248). + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 17 Nov 2016 21:10:30 +0300 + +sphinx (1.4.8-1) unstable; urgency=medium + + * New upstream bugfix release. + * Stop running jstest during build (but still run it in the autopkgtest). + * Update debian/watch to track only stable versions. + * Make dh_sphinxdoc generate ${sphinxdoc:Built-Using} substvar (closes: + #836248). + * Call dh_strip_nondeterminism during build. + * Build-depend on python3-xapian again, now it is in unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 03 Oct 2016 17:24:50 +0300 + +sphinx (1.4.6-1) unstable; urgency=medium + + * New upstream bugfix release (closes: #835026). + * Bump python[3]-six dependency to 1.5, following upstream. + * dh_sphinxdoc: Include the list of packages in the error message about + documentation not found (closes: #833799). + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 24 Aug 2016 21:04:54 +0300 + +sphinx (1.4.5-1) unstable; urgency=medium + + * New upstream bugfix release. + * Drop upstream patches: + - fix_ltz_utcoffset.diff + - latex_code_robust.diff + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 13 Jul 2016 22:56:54 +0300 + +sphinx (1.4.4-3) unstable; urgency=medium + + * Backport upstream patch (latex_code_robust.diff) to fix the \code + command in generated LaTeX files (closes: #829118). + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 01 Jul 2016 20:59:46 +0300 + +sphinx (1.4.4-2) unstable; urgency=medium + + * Update Python 2 autopkgtest to not run tests that require Python 3. + * Add a patch to fix return type of LocalTimeZone.utcoffset when + SOURCE_DATE_EPOCH is set (fix_ltz_utcoffset.diff). + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 21 Jun 2016 17:33:28 +0300 + +sphinx (1.4.4-1) unstable; urgency=medium + + * New upstream bugfix release. + - Autodoc now removes all memory addresses (closes: #822197). + * Drop python3-xapian build-dependency for unstable upload: it is not + yet available in unstable. + * Build-depend on graphviz so that the corresponding tests are not + skipped. + * Do not install the bundled TeX files from texinput directory: + - fncychap.sty (available in texlive-latex-extra) + - iftex.sty (available in texlive-generic-extra) + - needspace.sty (available in texlive-latex-extra) + - newfloat.sty (available in texlive-latex-recommended) + * Suggest texlive-generic-extra instead (the other packages are already in + the Suggests list). + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 17 Jun 2016 18:42:56 +0300 + +sphinx (1.4.3-1) experimental; urgency=medium + + * New upstream bugfix release. + * Drop the following patches, applied upstream: + - 0004-Extend-SOURCE_DATE_EPOCH-support.patch + - 0005-Adapt-to-typing-private-API-change-in-Python-3.5.2.patch + - 0006-Make-custom-compile_catalog-command-work-with-Babel-.patch + - 0007-Load-compatibility-patch-for-LuaTeX-0.85.patch + - 0008-Make-Xapian-search-work-with-Python-3.patch + * Add Takeshi KOMIYA’s signing key to debian/upstream/signing-key.asc. + * Bump version number in sphinx-autogen manpage. + * Build-depend on texlive-generic-extra (for iftex package). + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 06 Jun 2016 19:47:32 +0300 + +sphinx (1.4.1-2) experimental; urgency=medium + + * Add a patch to make Xapian search tests pass with Python 3. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 26 May 2016 13:45:43 +0300 + +sphinx (1.4.1-1) experimental; urgency=medium + + * New upstream release (closes: #824375). + * Drop the following patches, applied upstream: + - disable_distribute_setup.diff + - source_date_epoch.diff + - reproducible_grammar.diff + - reproducible_inventory.diff + - reproducible_js_locale.diff + - reproducible_searchindex.diff + * Refresh and rebase other patches. + * Update debian/watch to correctly mangle upstream alpha releases. + * Demote sphinx-rtd-theme to Suggests, it has become optional. + * Add dependency on python[3]-imagesize packages. + * Bump Pygments build- and test dependencies to 2.1.1. + * Demote python-sphinx recommendation of sphinx-doc to a suggestion. + * Refactor the command to run tests to better match upstream. + * Build-depend on dvipng to get the pngmath test run. + * Update numbers in jstest/run-tests for the new version. + * Add a patch from Alexis Bienvenüe to extend SOURCE_DATE_EPOCH support + (closes: #820895). + * Add a patch to fix a typing-related test failure with Python 3.5.2. + * Update debian/copyright based on upstream LICENSE and AUTHORS files. + * Add a patch to make compile_catalog code work with python-babel 2.3. + * Add a patch to support LuaTeX 0.85. + * Build-depend on texlive-luatex for tests. + * Adapt dh-sphinxdoc/install-js for doctools.js changes. + * Update sphinx-autogen manpage. + * Bump Standards-Version to 3.9.8, no changes needed. + * Build-depend on python3-xapian (closes: #649488). + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 17 May 2016 18:57:02 +0300 + +sphinx (1.3.6-2) unstable; urgency=medium + + * Use implementation of jstest from Iain Lane in hope it succeeds on + buildds. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 03 Mar 2016 20:17:15 +0300 + +sphinx (1.3.6-1) unstable; urgency=medium + + * New upstream bugfix release. + * Port jstest to WebKit2 (closes: #814909). + * Remove the now obsolete debian/TODO file. + * Update debian/source/lintian-overrides for new Lintian versions. + * Use https in Vcs-Git field. + * Bump Standards-Version to 3.9.7, no changes needed. + + -- Dmitry Shachnev <mitya57@debian.org> Wed, 02 Mar 2016 10:24:30 +0300 + +sphinx (1.3.5-1) unstable; urgency=medium + + * New upstream bugfix release. + * Build-depend on Pygments 2.1, the testsuite now requires it. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 26 Jan 2016 12:57:34 +0300 + +sphinx (1.3.4-1) unstable; urgency=medium + + * New upstream bugfix release. + * Clean and ignore auto-generated files. + * jstest.py: Add gi.require_version() calls to fix warnings from PyGI. + * Bump version number in sphinx-autogen manpage. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 14 Jan 2016 19:01:44 +0300 + +sphinx (1.3.3-1) unstable; urgency=medium + + * New upstream bugfix release. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 03 Dec 2015 18:35:09 +0300 + +sphinx (1.3.2-1) unstable; urgency=medium + + * New upstream release. + * Drop the following patches, applied upstream: + - py35compat.diff + - no_theme_rename_warning.diff + - addto_only_babel.diff + - print_help.diff + - compat_css.diff + * Refresh and rebase other patches. + * Stop exporting SOURCE_DATE_EPOCH in debian/rules. + Debhelper does it automatically since version 9.20151004. + * Update sphinx-autogen.1 man page. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 30 Nov 2015 18:31:36 +0300 + +sphinx (1.3.1-8) unstable; urgency=medium + + * Do not fail on removing SOURCES.txt file when it does not exist. + Fixes build with dh-python ≥ 2.20151103. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 08 Nov 2015 16:13:14 +0300 + +sphinx (1.3.1-7) unstable; urgency=medium + + * Make libjs-sphinxdoc depend on libjs-jquery ≥ 1.11.1 and libjs-underscore + ≥ 1.3.1, as these are the versions used by upstream. + * Fix command in autopkgtests to make them pass. + * Update Vcs fields for Git migration. + + -- Dmitry Shachnev <mitya57@debian.org> Sun, 18 Oct 2015 18:38:38 +0300 + +sphinx (1.3.1-6) unstable; urgency=medium + + * Update reproducibility patches to the latest version from Val Lorentz: + - Update reproducible_grammar.diff. + - Make searchindex generation deterministic (reproducible_searchindex.diff). + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 03 Sep 2015 16:54:07 +0300 + +sphinx (1.3.1-5) unstable; urgency=medium + + * Fix remaining reproducibility issues (closes: #795976): + - Export SOURCE_DATE_EPOCH in debian/rules. + - Set PYTHONHASHSEED=0 when generating grammar files. + - Make grammar generation deterministic (reproducible_grammar.diff). + - Make inventory generation deterministic (reproducible_inventory.diff). + - Make JavaScript locales deterministic (reproducible_js_locale.diff). + Many thanks to Val Lorentz for the patches. + * Drop XS-Testsuite header, no longer needed with dpkg ≥ 1.17.11. + + -- Dmitry Shachnev <mitya57@debian.org> Thu, 20 Aug 2015 11:56:56 +0300 + +sphinx (1.3.1-4) unstable; urgency=medium + + * Fix message when calling sphinx-build without arguments + (print_help.diff; closes: #792715). + * Add compatibility default.css file (compat_css.diff). + * Upload to unstable. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 15 Aug 2015 18:04:49 +0300 + +sphinx (1.3.1-3) experimental; urgency=medium + + * Update debian/TODO with the actual information. + * Backport upstream patch to disable warning about renamed default theme + (no_theme_rename_warning.diff). + * Backport upstream patch to not insert babel-specific code to generated + LaTeX files when babel is not in use (addto_only_babel.diff). + * Add support for $SOURCE_DATE_EPOCH environment variable, to make + the documentation builds reproducible (source_date_epoch.diff). + * dh_sphinxdoc: Symlink css3-mediaqueries.js, thanks to Jakub Wilk + for the patch (closes: #793045). + * dh_sphinxdoc: Add support for symlinking files specific to the RTD + theme (closes: #781849). + * Bump version number in sphinx-autogen manpage. + * Drop initialize_autodoc.diff, the bug seems to be fixed differently + upstream. + * Update bug URL in a comment in debian/rules for move to GitHub. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 28 Jul 2015 22:19:39 +0300 + +sphinx (1.3.1-2) experimental; urgency=medium + + [ Dmitry Shachnev ] + * debian/patches/no_snowballstemmer.diff: Exclude snowballstemmer + from setup.py and egg-info requirements. + * Move the signing keys to debian/upstream/signing-key.asc. + + [ Barry Warsaw ] + * debian/patches/py35compat.diff: Python 3.5 compatibility. + + -- Dmitry Shachnev <mitya57@debian.org> Tue, 30 Jun 2015 21:02:36 +0300 + +sphinx (1.3.1-1) experimental; urgency=medium + + [ Helmut Grohne ] + * Mark libjs-sphinxdoc Multi-Arch: foreign (closes: #779458). + + [ Dmitry Shachnev ] + * New upstream release. + - The codebase now works with Python 3 with no need to run 2to3. + - Output is now reproducible (closes: #776443). + * Remove patches: + - python3_test_build_dir.diff (no longer needed) + - parallel_2to3.diff (no longer needed) + - fix_latex_hlines.diff (applied upstream) + * Bump required versions of python, docutils and pygments. + * Build-depend and depend on: + - python[3]-six + - python[3]-babel + - python[3]-sphinx-rtd-theme + - python[3]-alabaster + * Add python[3]-mock to build-dependencies and test dependencies. + * Use upstream tarball, which now contains non-minified versions of + jquery.js and underscore.js. + * Update debian/watch to use pypi.debian.net redirector. + * Simplify debian/rules: + - Adjust for using upstream tarballs. + - Do not mention site-packages anymore. + * Update JS tests for the new version. + * Add a patch to skip JS libraries versions check. + * Drop 2to3 call from debian/tests/python3-sphinx. + * Properly clean up after running tests. + * Bring debian/copyright in sync with upstream AUTHORS file. + * Disable snowballstemmer-based search until upstream implements + it correctly (without JS blobs) and we get snowballstemmer packaged. + * Bump Standards-Version to 3.9.6, no changes needed. + * Override lintian false positive warnings about missing sources for + minified files (jquery.js, underscore.js, and css3-mediaqueries.js). + * debian/dh-sphinxdoc/install-js: Update list of files to be installed. + + -- Dmitry Shachnev <mitya57@debian.org> Sat, 02 May 2015 22:18:56 +0300 + +sphinx (1.2.3+dfsg-1) unstable; urgency=medium + + * New upstream bugfix release. + * Drop websupport_todo.diff, applied upstream. + * Update date and version in sphinx-autogen.1. + * Add Takayuki Shimizukawa’s signing key to upstream-signing-key.pgp. + * Replace links to online docutils docs with links to packaged + docutils docs. + + -- Dmitry Shachnev <mitya57@debian.org> Fri, 12 Sep 2014 11:49:40 +0400 + +sphinx (1.2.2+dfsg-4) unstable; urgency=medium + + * Build-depend on python3-whoosh, now when it is available. + * Drop sphinxcontrib_namespace.diff, all sphinxcontrib packages + are using dh_python2 now. Break old versions of issuetracker and + spelling packages. + * Update my e-mail address. + * Override false-positive Lintian errors about sourceless files. + * Generate compiled translations using compile_catalog command. + + -- Dmitry Shachnev <mitya57@debian.org> Mon, 08 Sep 2014 12:58:18 +0400 + +sphinx (1.2.2+dfsg-3) unstable; urgency=medium + + * Remove obsolete Recommends: on python-simplejson and Suggests: + on jsmath. + * debian/patches/websupport_todo.diff: Make websupport work with + todolist directives (closes: #754408). + + -- Dmitry Shachnev <mitya57@gmail.com> Mon, 25 Aug 2014 13:50:20 +0400 + +sphinx (1.2.2+dfsg-2) unstable; urgency=medium + + * Downgrade error about documentation not found to a warning + (closes: #745690). + * Cleanup dh_compress arguments. + * Export NO_PKG_MANGLE, needed to build on Ubuntu. + * Update version number and URL in sphinx-autogen man page. + + -- Dmitry Shachnev <mitya57@gmail.com> Sun, 18 May 2014 15:13:18 +0400 + +sphinx (1.2.2+dfsg-1) unstable; urgency=low + + * New upstream bugfix release. + * Drop html_logo_path_fix.diff, applied upstream. + * Refresh and rebase other patches. + * Update numbers in jstest/run-tests to match docs updates in the new + version. + * Bump debhelper compatibility level to 9. + * Backport upstream patch to fix writing table hlines in LaTeX writer + (closes: #732585). + + -- Dmitry Shachnev <mitya57@gmail.com> Mon, 03 Mar 2014 20:28:04 +0400 + +sphinx (1.2.1+dfsg-3) unstable; urgency=medium + + * Add html_logo_path_fix.diff to fix path check for HTML logo, + backported from upstream hg (thanks James Cowgill, closes: #738741). + * Add missing xauth depencency for sphinx-doc autopkgtest. + + -- Dmitry Shachnev <mitya57@gmail.com> Thu, 13 Feb 2014 12:54:23 +0400 + +sphinx (1.2.1+dfsg-2) unstable; urgency=medium + + * Move Grammar files to /usr/share/sphinx, the code still expects + that thay are in that location (closes: #736239). + + -- Dmitry Shachnev <mitya57@gmail.com> Tue, 21 Jan 2014 19:47:34 +0400 + +sphinx (1.2.1+dfsg-1) unstable; urgency=medium + + * New upstream release. + * Drop fix_jinja_recursion.diff, applied upstream. + * Drop unversioned_grammar_pickle.diff, a different fix was applied + upstream. + * No longer move Grammar.txt and Grammar.pickle to shared location, + upstream is now shipping different versions of grammar for Python 2 + and Python 3. + + -- Dmitry Shachnev <mitya57@gmail.com> Mon, 20 Jan 2014 18:28:47 +0400 + +sphinx (1.2+dfsg-2) unstable; urgency=medium + + * Backport upstream patch (fix_jinja_recursion.diff) to fix infinite + recursion when building python-numpy docs. + * Add explicit build-dependency on dh-python. + * JS tests: use WebView.load_uri() instead of deprecated open(). + + -- Dmitry Shachnev <mitya57@gmail.com> Sun, 12 Jan 2014 13:00:20 +0400 + +sphinx (1.2+dfsg-1) unstable; urgency=low + + * Upload to unstable. + * New upstream stable release. + * Drop fix_setup_command_test.diff, applied upstream. + * Refresh sphinxcontrib_namespace.diff. + * Fix package names in Recommends: python(3)-imaging → python(3)-pil. + * Bump Standards-Version to 3.9.5, no changes needed. + * Bump python-all build-dependency to 2.6.6-3~. + * Verify upstream PGP signature in debian/watch. + + -- Dmitry Shachnev <mitya57@gmail.com> Wed, 18 Dec 2013 17:25:19 +0400 + +sphinx (1.2~b3+dfsg-2) experimental; urgency=low + + * Really switch from dh_pysupport to dh_python2. + * Remove unwanted files from python-sphinx package (closes: #726754). + * Remove useless imports in jstest/jstest.py. + + -- Dmitry Shachnev <mitya57@gmail.com> Mon, 21 Oct 2013 20:55:27 +0400 + +sphinx (1.2~b3+dfsg-1) experimental; urgency=low + + [ Dmitry Shachnev ] + * New upstream beta release. + - Correctly handles errors when repr()-ing objects (closes: #706581). + * Drop upstream patches. + * Refresh and rebase other patches. + * Add a patch to make sure setup_command tests can import sphinx module. + * Switch debian/watch to use HTTPS. + * JS tests: + - Port from deprecated static bindings and Python 2 to PyGI and + Python 3. Update the dependencies accordingly. + - Do not use web server, instead set a WebKit option that will allow + us to access files directly. Now the pages should load faster + (closes: #724472). + * Switch from deprecated dh_pysupport to dh_python2 (closes: #659196). + * Add XS-Testsuite header, and replace XS-Python-Version with preferred + X-Python-Version (closes: #685508). + * Add myself to Uploaders. + + [ Jakub Wilk ] + * Remove myself from Uploaders. + + -- Dmitry Shachnev <mitya57@gmail.com> Sat, 05 Oct 2013 19:29:41 +0400 + +sphinx (1.2~b1+dfsg-2) experimental; urgency=low + + * Export http_proxy=http://127.0.0.1:9/ in debian/rules to prevent Internet + access at build time. + * Use canonical URIs for Vcs-* fields. + * Add texinfo to Build-Depends. + * Add patch (fix_copying_imgs_singlehtml_builder.diff) to fix copying images + in the singlehtml builder (closes: #706563). + * Add patch (fix_globaltoc_and_hidden_toctree.diff) to fix combination of + globaltoc and hidden toctree causing an exception (closes: #706586). + * Add patch (fix_missing_citation_target_assert.diff) to fix missing + citation target causing AssertionError (closes: #706565). + * Rename skiptest_latex.diff as skiptest.diff; fix more cases when a missing + tool was silently ignored. + * Set Debian Python Modules Team as Maintainer; move myself to Uploaders. + + -- Jakub Wilk <jwilk@debian.org> Tue, 04 Jun 2013 23:57:47 +0200 + +sphinx (1.2~b1+dfsg-1) experimental; urgency=low + + * New upstream beta release. + + Drop fix_nepali_po.diff; applied upstream. + + Drop fix_shorthandoff.diff; different fix applied upstream. + + Drop l10n_fixes.diff; applied upstream. + + Drop manpage_writer_docutils_0.10_api.diff; applied upstream. + + Drop pygments_byte_strings.diff; different fix applied upstream. + + Drop show_more_stack_frames.diff; an option to show full traceback (-T) + is now available. + + Drop sort_stopwords.diff; applied upstream. + + Drop support_python_3.3.diff; applied upstream. + + Drop test_build_html_rb.diff; applied upstream. + + Refresh other patches. + + Update integration tests for the JavaScript code. + + Update debian/copyright. + + Update debian/*.docs to take into account that README was renamed as + REAMDE.rst. + + Update version in sphinx-autogen manpage. + + This release fixes parsing C++11 “static constexpr” declarations + (closes: #693066). Thanks to Alexandre Duret-Lutz for the bug report and + the patch. + * Run tests under LC_ALL=C.UTF-8 to work around test failures. + * Make it impossible to accidentally build the source package with an + .orig.tar that includes jquery.js or underscore.js. + * Refactor debian/rules. + * When building our own documentation, run sphinx-build with the -T option. + * Use a dedicated script to extract JavaScript code for libjs-sphinxdoc. + * Add no_external_css.diff: don't use CSS files hosted on external sites. + + -- Jakub Wilk <jwilk@debian.org> Mon, 29 Apr 2013 23:37:06 +0200 + +sphinx (1.1.3+dfsg-7) experimental; urgency=low + + * Backport upstream patch for fix compatibility with Docutils 0.10. + * Run 2to3 in parallel. + * Add DEP-8 tests for the documentation package. + + -- Jakub Wilk <jwilk@debian.org> Wed, 19 Dec 2012 10:53:51 +0100 + +sphinx (1.1.3+dfsg-6) experimental; urgency=low + + [ Jakub Wilk ] + * DEP-8 tests: remove “Features: no-build-needed”; it's the default now. + * Bump standards version to 3.9.4; no changes needed. + * Pass -a to xvfb-run, so that it tries to get a free server number. + * Rebuild MO files from source. + + Update debian/rules. + + Add the rebuilt files to extend-diff-ignore. + * Make synopses in the patch header start with a lowercase latter and not + end with a full stop. + + [ Dmitry Shachnev ] + * debian/patches/l10n_fixes.diff: fix crashes and not working external + links in l10n mode (closes: #691719). + * debian/patches/sort_stopwords.diff: mark as applied upstream. + + -- Jakub Wilk <jwilk@debian.org> Sat, 08 Dec 2012 14:38:19 +0100 + +sphinx (1.1.3+dfsg-5) experimental; urgency=low + + [ Jakub Wilk ] + * DEP-8 tests: use $ADTTMP. + * dh_sphinxdoc: ignore comments when analysing HTML files (closes: #682850). + Thanks to Dmitry Shachnev for the bug report. + * Add dvipng to Suggests (closes: #687273). Thanks to Matthias Klose for the + bug report. + * Set PYTHONHASHSEED=random in debian/rules and in DEP-8 tests. + * Backport upstream patch to fix encoding issues in test_build_html. Now + that this is fixed, stop running Python 3 tests under LC_ALL=C. + * Make “debian/rules binary-arch” no-op. + * Update version number in the sphinx-autogen manpage. + * Improve dh_sphinxdoc: + + Fix the --tmpdir option. Thanks to Andriy Senkovych for the bug report. + + Ignore references to JavaScript code that start with an URI scheme. + Thanks to Dmitry Shachnev for the bug report. + + Strip query (?...) and fragment (#...) components from JavaScript + references. Thanks to Dmitry Shachnev for the bug report. + * Sort stopwords in searchtools.js. Thanks to Dmitry Shachnev for the bug + report. + * Fix compatibility with Python 3.3. Thanks to Dmitry Shachnev for the bug + report and hunting down the upstream patch. + + [ Dmitry Shachnev ] + * Update Homepage field to point to http://sphinx-doc.org/. + * Build-depend of python3-all instead of python3. + + -- Jakub Wilk <jwilk@debian.org> Thu, 08 Nov 2012 16:28:23 +0100 + +sphinx (1.1.3+dfsg-4) unstable; urgency=low + + * Add DEP-8 tests. + * LaTeX writer: fix generation of \shorthandoff (closes: #672586, + LP: #997891). Thanks to Melissa Draper for the bug report and the initial + patch. + + -- Jakub Wilk <jwilk@debian.org> Thu, 24 May 2012 18:53:29 +0200 + +sphinx (1.1.3+dfsg-3) unstable; urgency=low + + * Validate *.po files at build time. Add gettext to Build-Depends. + * Add fix_nepali_po.diff: remove Nepali translations that must have been + wrong. + * Add pygments_byte_strings.diff: fix Unicode issues in + PygmentsBridge.highlight_block (closes: #660930). Thanks to Anton Gladky + for the bug report and the initial patch. + * Fix a typo in a patch description. + + -- Jakub Wilk <jwilk@debian.org> Mon, 02 Apr 2012 22:17:49 +0200 + +sphinx (1.1.3+dfsg-2) unstable; urgency=low + + * Upload to unstable. + * Add skiptest_latex.diff: if LaTeX (or a required LaTeX package) is not + found when running test_build_latex, raise SkipTest instead of just + printing a message to stderr. + + -- Jakub Wilk <jwilk@debian.org> Wed, 14 Mar 2012 20:31:19 +0100 + +sphinx (1.1.3+dfsg-1) experimental; urgency=low + + * New upstream release. + + Drop python3_test_syspath.diff, applied upstream. + + Update integration tests for the JavaScript code. + * Bump standards version to 3.9.3 (no changes needed). + + -- Jakub Wilk <jwilk@debian.org> Mon, 12 Mar 2012 12:18:37 +0100 + +sphinx (1.1.2+dfsg-5) unstable; urgency=low + + * Don't run ‘python setup.py clean’ in the clean target (we nuke the whole + build subdirectory anyway). + * Move python-all and python-setuptools from Build-Depends to + Build-Depends-Indep, as it's not needed in the clean target anymore. + * Don't run dh_testroot in the clean target. There's a good chance that root + privileges are not needed (e.g. because binary target was run under + fakeroot), and even if they are actually needed, the target will fail + quickly. + * Run tests against Python 3: + + Add build-dependency on python3-nose, python3-docutils, + python3-pygments, python3-jinja2, python3-sqlalchemy. + + Add python3_test_syspath.diff to fix Python 3 sys.path for the test + runner. + + Add python3_test_build_dir.diff to hardcode Python 3 build directory in + the test runner to the one that the package uses. + + Add test running code debian/rules. Don't use --no-skip for the moment, + as some required packages don't exist yet (see #647441, #647439). Set + LC_ALL=C.UTF-8 to work around failures under LC_ALL=C (see + <http://deb.li/H8ED> and <http://deb.li/3Rw0z>). + + -- Jakub Wilk <jwilk@debian.org> Tue, 14 Feb 2012 00:13:35 +0100 + +sphinx (1.1.2+dfsg-4) unstable; urgency=low + + * Make the build actually fail if integration tests for the JavaScript + code fail. + * Don't remove *.egg-info in the clean target; add it to extend-diff-ignore + instead. + * Pass --no-guessing-deps to dh_python3. + + -- Jakub Wilk <jwilk@debian.org> Sun, 05 Feb 2012 19:33:59 +0100 + +sphinx (1.1.2+dfsg-3) unstable; urgency=low + + * Upload to unstable (closes: #655637). + * Use xargs to iterate over all Python versions. + * Make sphinx-autogen initialize the sphinx.ext.autodoc module (hopefully + closes: #611078). + + -- Jakub Wilk <jwilk@debian.org> Sun, 05 Feb 2012 17:59:55 +0100 + +sphinx (1.1.2+dfsg-2) experimental; urgency=low + + * Add sphinxcontrib_namespace.diff: create namespace package + ‘sphinxcontrib’. This allows python-sphinxcontrib.* packages, both those + using dh_python2 and those using python-support, to be co-importable. + * Add various texlive-* and libjs-mathjax to Suggests. + * Don't install SOURCES.txt into binary packages. + * dh_sphinxdoc: produce different diagnostic message when unknown JavaScript + script is being ignored than when it's a fatal error. Thanks to Sandro + Tosi for the bug report. + * Make the get-orig-source script create temporary files in /tmp (or + $TMPDIR). + * Revert all the changes to manual pages that accumulated over the years. + * Document that symlinking translations.js and non-English searchtools.js is + not supported (see bug #658238). + * Don't include websupport.js in libjs-jquery. Make dh_sphinxdoc remove this + file from binary package. + * dh_sphinxdoc: -X<item> should now exclude a file if <item> exists anywhere + in the path, so it can be used e.g. to exclude whole directories. + * Fix a typo in dh_sphinxdoc manual page. + + -- Jakub Wilk <jwilk@debian.org> Fri, 03 Feb 2012 13:52:49 +0100 + +sphinx (1.1.2+dfsg-1) experimental; urgency=low + + * New upstream release (closes: #649048). + + Drop autosummary_1.0.6.patch for the time being (reopens: #611078). + + Drop docstring_parse.diff, applied upstream. + + Rename disable_ez_setup.diff to disable_distribute_setup.diff. + + Drop move_static_files_outside_site-packages.patch. Most of it was + applied upstream, the remaining bits are now taken care of in + debian/rules. + + Refresh other patches. + + Update integration tests for the JavaScript code. + + Bump minimum required versions: + - python-docutils to >= 0.7; + - python-pygments to >= 1.2; + - python-jinja2 to >= 2.3. + - python to >= 2.5. + + Add code to install also JavaScript files that are generated at build + time. Add websupport.js to dh_sphinxdoc index. + + Update debian/copyright. + * Texinfo output format is now supported (closes: #586747). + * Update version numbers in the manual pages. Add a build-time warning to be + emitted if they ever get out of date again. + * Build manual pages (except for sphinx-autogen.1) from reStructuredText + sources. + * Rephrase short package description, so that it's... shorter. + * New binary package: sphinx-common, containing manual pages, templates, + translations and other data files. + * New binary package: sphinx-doc, containing documentation. + + Conflict with previous versions python-sphinx. + + /usr/share/doc/python-sphinx/html used to be a directory, but is now a + symlink. Conflict with older versions of python-docutils, so that dpkg + can replace one with the other. Add lintian override. + * New binary package: python3-sphinx. + + Both python-sphinx and python3-sphinx provide sphinx-* scripts. The + scripts have: + #!/usr/bin/python3 shebang if only python3-sphinx is installed; + #!/usr/bin/python shebang otherwise. + + /usr/bin/sphinx-* are now symlinks and are managed by docutils-common + postinst/postrm maintainer scripts. + + Make sphinx-common conflict with older versions of python-sphinx that + were shipping /usr/bin/sphinx-* scripts. Add lintian override for + conflicts-with-version. + + Add build-dependency on python3 (needed for dh_python3) and + python3-setuptools. + + Add X-Python3-Version field. + * Improve debian/rules: + + Run dh_install with --fail-missing. + + Refactor the code responsible for moving data into a private directory. + Rename some variables to make them lowercase. Don't use CURDIR where + it's not necessary. + + Make it possible to rebuild the package without running clean target. + + Remove unneeded mkdir calls. + + Use a for loop in debian/rules to install all sphinx-* scripts. + + Run nosetests with --verbose --no-skip. + * Add build-dependency on the following packages (needed for the test + suite): python-sqlalchemy, python-whoosh, python-xapian. + * Use XS-Python-Version instead of debian/pyversions. + + -- Jakub Wilk <jwilk@debian.org> Sun, 20 Nov 2011 15:56:50 +0100 + +sphinx (1.0.8+dfsg-2) unstable; urgency=low + + * Upload to unstable. + + -- Jakub Wilk <jwilk@debian.org> Wed, 12 Oct 2011 00:34:20 +0200 + +sphinx (1.0.8+dfsg-1) experimental; urgency=low + + * New upstream release. + + Drop fix_jquery_1.5_incompatibility.diff, applied upstream. + + Drop fix_test_build_latex.diff, applied upstream. + + Refresh other patches. + * Export PYTHONWARNINGS=d in debian/rules to enable all warnings in Python + code. + + -- Jakub Wilk <jwilk@debian.org> Wed, 28 Sep 2011 17:20:22 +0200 + +sphinx (1.0.7+dfsg-2) unstable; urgency=low + + * JavaScript test suite: don't hang if get_title() returns None. Thanks to + Ansgar Burchardt for the bug report. + * dh_sphinxdoc: + + Fix a typo in the manual page. + + Don't check for existence of source files if HAS_SOURCE is false + (closes: #641710). Thanks to Raphaël Hertzog for the bug report. + * Disable use of ez_setup in setup.py. + * Set myself as maintainer. Thanks to Mikhail Gusarov for his past work! + + -- Jakub Wilk <jwilk@debian.org> Thu, 15 Sep 2011 13:53:16 +0200 + +sphinx (1.0.7+dfsg-1) unstable; urgency=medium + + * Strip jQuery and Underscore.js from the upstream tarball (closes: + #631535). + + Add get-orig-source target. + + Remove them from debian/copyright. + + Add build-dependency on libjs-underscore, + + Update watch file to deal with the +dfsg suffix. + * Unify multiple calls to dh_link. + * Use build/html as build directory for documentation. + * Add integration tests for the JavaScript code. They should allow us to + avoid bugs like #625208 or #628642 in the future. + + Build-depend on xvfb, xauth, python-webkit, libjs-jquery and + libjs-underscore. + * Add build-arch and build-indep targets to debian/rules. + * Add new tool, dh_sphinxdoc that aids shipping Sphinx-generated + documentation in Debian packages. + + Update debian/rules, debian/control and debian/*.links to use + dh_sphinxdoc. + + Use pod2man to generate manpage. Add dependency on perl. Update + debian/manpages and debian/clean. + * Move all JavaScript code into a separate package, libjs-sphinxdoc. + * Fix test_build_latex to not fail in a directory with special characters. + * Use debian/clean rather than listing files to clean directly in + debian/rules. + + -- Jakub Wilk <jwilk@debian.org> Sun, 10 Jul 2011 22:43:16 +0200 + +sphinx (1.0.7-5) unstable; urgency=low + + [ Jakub Wilk ] + * Bump standards version to 3.9.2 (no changes needed). + * Bump minimum required version of jQuery to 1.4. + * Use python (>= 2.6.6-14~) as an alternative build-dependency to + python-simplejson. The latter package is only needed for python2.5, and + python-defaults 2.6.6-14 doesn't support it anymore. + * Include jQuery source (closes: #630973). + + Check at build time if versions of both jQuery copies match. + + [ Nikolaus Rath ] + * Backport upstream changesets a8b0ef275438 and de340a6098c7 to allow + extraction of function signature from docstring for extension modules. + (closes: #630409). The feature is disabled by default for the moment. + + -- Jakub Wilk <jwilk@debian.org> Sun, 19 Jun 2011 14:44:49 +0200 + +sphinx (1.0.7-4) unstable; urgency=low + + * When Sphinx crashes, show 10 stack frames (instead of a single one). + * Backport upstream patch to fix incompatibility with jQuery >= 1.5 + (closes: #625208). Thanks to Tshepang Lekhonkhobe for the bug report. + + -- Jakub Wilk <jwilk@debian.org> Thu, 19 May 2011 11:59:00 +0200 + +sphinx (1.0.7-3) unstable; urgency=low + + [ Mikhail Gusarov ] + * Change my email address. + + [ Jakub Wilk ] + * New upstream release (closes: #613207). + + Refresh patches. + + Revert changes to the autosummary extension introduced in 1.0.7 + (closes: #611078). + * Don't compress objects.inv. Thanks to Michael Fladischer for the bug + report. + * Remove *.egg-info in the clean target. + * Move pycode/Grammar.txt and ext/autosummary/templates/* out of + /usr/share/pyshared/ (closes: #609486). + * Stop embedding Python version in filename of grammar pickle. + * Ship grammar pickle in the binary package (closes: #613412). Thanks to + Frederic-Emmanuel Picca for the bug report. + * Drop preinst script to remove python-central leftovers; not needed + anymore. + * New upstream release. + * Update and significantly rewrite manual pages (closes: #593623). + * Switch to source format 3.0 (quilt). + + Drop README.source. + + Refresh patches. + + Update debian/rules. + + Drop quilt from build-depends. + * Update debian/copyright. + * Use DEP-3 format for patch headers. + * Run tests at build time. + + Add python-nose, python-simplejson and + texlive-{latex-{recommended,extra},fonts-recommended} to + Build-Depends-Indep. + + Patch test runner to import modules correctly and prevent it from + reading files in /usr/share/sphinx. + + Update debian/rules. + * Bump standards version to 3.9.1 (no changes needed). + * Add ‘set -e’ to a for loop in debian/rules. + + [ Piotr Ożarowski ] + * Minimum required versions bumped: + - python-jinja2 >= 2.2 + - python-docutils >= 0.5 + * move_static_files_outside_site-packages.patch updated + + [ Stefano Rivera ] + * Improve language and clarify options in manpages. + + -- Jakub Wilk <jwilk@debian.org> Mon, 04 Apr 2011 13:50:56 +0200 + +sphinx (0.6.6-3) unstable; urgency=low + + * Add myself to uploaders. + * Fix formatting of the manual pages. + * Update and significantly rewrite the sphinx-build manual page + (closes: #593623). + * Bump standards version to 3.9.1 (no changes needed). + + -- Jakub Wilk <jwilk@debian.org> Mon, 30 Aug 2010 00:26:04 +0200 + +sphinx (0.6.6-2) unstable; urgency=low + + * Team upload. + + [ Mikhail Gusarov ] + * Fix preinst script to correctly remove python-central remnants (Closes: + #559572). + + -- Jakub Wilk <jwilk@debian.org> Fri, 06 Aug 2010 16:33:55 +0200 + +sphinx (0.6.6-1) unstable; urgency=low + + [ Piotr Ożarowski ] + * New upstream release + - disable_ez_setup.patch removed, no longer needed + - move_static_files_outside_site-packages.patch updated + * Bump Standards-Version to 3.8.4, no changes needed. + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Tue, 25 May 2010 22:30:46 +0200 + +sphinx (0.6.5-1) unstable; urgency=low + + [ Piotr Ożarowski ] + * New upstream release + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Mon, 29 Mar 2010 23:08:45 +0200 + +sphinx (0.6.4-1) unstable; urgency=low + + [ Piotr Ożarowski ] + * New upstream release + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Wed, 13 Jan 2010 23:26:40 +0100 + +sphinx (0.6.3-2) unstable; urgency=low + + [ Piotr Ożarowski ] + * Add preinst maintainer script to remove python-central leftovers; thanks to + Jakub Wilk for the report; Closes: #559572 + + [ Sandro Tosi ] + * debian/control + - added misc:Depends to the binary package Depends line + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Sun, 03 Jan 2010 22:37:20 +0600 + +sphinx (0.6.3-1) unstable; urgency=low + + * New upstream release (Closes: #545042): + - handle error when using autoclass with a non-class (Closes: #537165) + - all patches refreshed. + * Use debian/pyversions instead of X[SB]-Python-Version. + * Add doc-base file for manual. + * Bump Standards-Version, no changes needed. + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Fri, 04 Sep 2009 17:49:20 +0700 + +sphinx (0.6.2-1) unstable; urgency=low + + [ Piotr Ożarowski ] + * New upstream release (Closes: #527538) + - add_missing_sphinx-autogen and rfind-invocation patches removed, no + longer needed + - move_static_files_outside_site-packages.patch updated + * Standards-Version bumped to 3.8.2, no changes needed. + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Wed, 17 Jun 2009 19:32:26 +0200 + +sphinx (0.6.1-2) unstable; urgency=low + + [ Mikhail Gusarov ] + * Fix debian/README.source: s/dpatch/quilt/ (Closes: #523293). + * Add debian/rfind-invocation.patch, fixing breakage on python-werkzeug + docs. + + [ Piotr Ożarowski ] + * Install .mo files (Closes: #526027) + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Sun, 12 Apr 2009 14:37:30 +0700 + +sphinx (0.6.1-1) unstable; urgency=low + + [ Piotr Ożarowski ] + * New upstream release + + depend on python-jinja2 instead of python-jinja + * Add move_static_files_outside_site-packages patch + * Build depend on python-all (>= 2.5.4-1) (py_libdir is now used in + debian/rules) + * add_missing_sphinx-autogen.patch added (missing file will be added in next + upstream release) + + [ Jan Dittberner ] + * add man page debian/sphinx-autogen.1 + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Tue, 07 Apr 2009 18:24:25 +0100 + +sphinx (0.5.2-1) unstable; urgency=low + + [ Piotr Ożarowski ] + * New upstream release (Closes: #517735) + + bump python-jinja minimum required version to 1.2 + * Switch to python-support + * remove .pickle file in clean rule + * Standards-Version bumped to 3.8.1, no changes needed. + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Tue, 24 Mar 2009 21:26:26 +0100 + +sphinx (0.5.1-2) unstable; urgency=low + + [ Piotr Ożarowski ] + * Upload to unstable + * Add debian/README.source file + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Sat, 07 Feb 2009 15:31:02 +0100 + +sphinx (0.5.1-1) experimental; urgency=low + + [ Piotr Ożarowski ] + * New upstream release + + Closes: #507647 + + upload to experimental due to Lenny freeze, to ease testing rev. + dependencies + * Add disable_ez_setup patch (and quilt to build dependencies) so that it + will not try to download stuff that is already installed on the system + * Add jsmath to suggested packages (Closes: #507691) + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Wed, 17 Dec 2008 18:42:59 +0100 + +sphinx (0.5-1) experimental; urgency=low + + [ Sandro Tosi ] + * debian/control + - switch Vcs-Browser field to viewsvn + + [ Piotr Ożarowski ] + * New upstream release (upload to experimental due to Lenny freeze, to ease + testing rev. dependencies) + * Add python (>=2.6) | python-simplejson and python-imaging to Recommends + * Remove .doctrees directory from docs/html + * Bump python-jinja's required version to >= 1.1 + + -- Debian Python Modules Team <python-modules-team@lists.alioth.debian.org> Sun, 23 Nov 2008 21:49:50 +0100 + +sphinx (0.4.2-1) unstable; urgency=medium + + * New upstream version. Fixes bug with broken show-inheritance in + automodule (Closes: #492732) + * Urgency medium, fixes RC bug. + * Using jQuery from Debian package, not bundled one: + - Added dependency on libjs-jquery, + - Replaced jquery.js by symlink to /usr/share/javascript/jquery/jquery.js + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Tue, 29 Jul 2008 17:55:27 +0700 + +sphinx (0.4.1-2) unstable; urgency=low + + * debian/control: sphinx is not compatible with python 2.3, so + XS-Python-Version: >= 2.4 (Closes: #490537). + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Sat, 12 Jul 2008 20:13:12 +0700 + +sphinx (0.4.1-1) unstable; urgency=low + + * New upstream version. + * All patches removed, applied upstream: + - Removed quilt build-dep + - Removed quilt patch/unpatch targets in debian/rules. + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Wed, 09 Jul 2008 02:57:25 +0700 + +sphinx (0.4-1) unstable; urgency=low + + * New upstream version. + * Standards-Version bumped to 3.8.0, no changes needed. + * Vcs-{Svn,Browser} added. + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Mon, 23 Jun 2008 19:31:00 +0700 + +sphinx (0.3-2) unstable; urgency=medium + + * Added missing python-docutils dependency (Closes: #482916). + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Mon, 26 May 2008 04:44:14 +0700 + +sphinx (0.3-1) unstable; urgency=low + + * New upstream version. + * Fixed typo in package description (Closes: #479285). + * debhelper compatibility level bumped to 7: + - Updated debhelper dependency + - debian/rules: stamp files are removed automatically + * Removed empty debian/examples file. + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Sun, 04 May 2008 13:44:34 +0700 + +sphinx (0.2-1) unstable; urgency=low + + * New upstream version. + * sphinx no longer bundles jinja in tarball: + - nuked jinja removal code from debian/rules, + - added build-depencency to python-jinja for documentation generation, + - updated debian/copyright, removing information about jinja copyrights + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Thu, 01 May 2008 11:00:18 +0700 + +sphinx (0.1.61950-1) unstable; urgency=low + + * Initial release (Closes: #474782) + * Added patch disable-sphinx-web.patch, disabling installation of + sphinx-web, which is not yet ready. + * Added patch add_shebangs.patch, adding shebangs in sphinx-build and + sphinx-quickstart + * Added manpages for sphinx-build(1) and sphinx-quickstart(1). + * Removed bundled jinja instance. + + -- Mikhail Gusarov <dottedmag@dottedmag.net> Sun, 20 Apr 2008 23:01:50 +0200 diff --git a/debian/clean b/debian/clean new file mode 100644 index 0000000..02eab8d --- /dev/null +++ b/debian/clean @@ -0,0 +1,14 @@ +.pytest_cache/ +Sphinx.egg-info/PKG-INFO +Sphinx.egg-info/SOURCES.txt +Sphinx.egg-info/entry_points.txt +Sphinx.egg-info/requires.txt +debian/dh-sphinxdoc/*.1 +debian/dh-sphinxdoc/.doctrees/ +doc/.doctrees/ +sphinx/locale/*/LC_MESSAGES/sphinx.js +sphinx/locale/*/LC_MESSAGES/sphinx.mo +sphinx/pycode/*.pickle +sphinx/themes/basic/static/jquery*.js +sphinx/themes/basic/static/underscore*.js +tests/build/ diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..b0a1b96 --- /dev/null +++ b/debian/control @@ -0,0 +1,141 @@ +Source: sphinx +Section: python +Priority: optional +Maintainer: Debian Python Team <team+python@tracker.debian.org> +Uploaders: Dmitry Shachnev <mitya57@debian.org> +Homepage: https://www.sphinx-doc.org/ +Build-Depends: debhelper-compat (= 13) +Build-Depends-Indep: dh-python (>= 3.20180313~), + dpkg-dev (>= 1.17.14), + dvipng, + flit (>= 3.7), + fonts-freefont-otf, + graphviz, + imagemagick-6.q16, + libjs-jquery (>= 1.4), + libjs-underscore, + libjson-perl <!nodoc>, + librsvg2-bin, + perl, + pybuild-plugin-pyproject, + python-requests-doc <!nodoc>, + python3-alabaster (>= 0.7), + python3-all (>= 3.3.3-1~), + python3-babel (>= 1.3), + python3-doc <!nodoc>, + python3-docutils (>= 0.14), + python3-html5lib, + python3-imagesize, + python3-jinja2 (>= 2.3), + python3-lib2to3, + python3-packaging, + python3-pygments (>= 2.13), + python3-pytest, + python3-requests (>= 2.5.0), + python3-setuptools, + python3-snowballstemmer (>= 1.1), + python3-sphinxcontrib.websupport <!nodoc>, + tex-gyre, + texinfo, + texlive-fonts-recommended, + texlive-latex-extra, + texlive-latex-recommended, + texlive-luatex, + texlive-xetex +Rules-Requires-Root: no +Standards-Version: 4.6.2 +Vcs-Git: https://salsa.debian.org/python-team/packages/sphinx.git +Vcs-Browser: https://salsa.debian.org/python-team/packages/sphinx + +Package: python3-sphinx +Architecture: all +Depends: python3-distutils, + sphinx-common (= ${source:Version}), + ${misc:Depends}, + ${python3:Depends} +Recommends: make, python3-pil +Suggests: dvipng, + fonts-freefont-otf, + imagemagick-6.q16, + latexmk, + libjs-mathjax, + python3-lib2to3, + python3-sphinx-rtd-theme, + sphinx-doc, + tex-gyre, + texlive-fonts-recommended, + texlive-latex-extra, + texlive-latex-recommended, + texlive-plain-generic +Provides: sphinx (= ${binary:Version}) +Breaks: python3-breathe (<< 4.15), + python3-nbsphinx (<< 0.8.7), + python3-sphinx-celery (<< 2.0.0), + python3-sphinx-tabs (<< 3.4.0), + python3-sphinxcontrib.serializinghtml (<< 1.1.5), + python3-sphinxcontrib.websupport (<< 1.1.2) +Conflicts: python-sphinx +Description: documentation generator for Python projects + Sphinx is a tool for producing documentation for Python projects, using + reStructuredText as markup language. + . + Sphinx features: + * HTML, CHM, LaTeX output, + * Cross-referencing source code, + * Automatic indices, + * Code highlighting, using Pygments, + * Extensibility. Existing extensions: + - automatic testing of code snippets, + - including docstrings from Python modules. + . + Build-depend on sphinx if your package uses /usr/bin/sphinx-* + executables. Build-depend on python3-sphinx if your package uses + the Python API (for instance by calling python3 -m sphinx). + +Package: sphinx-common +Architecture: all +Multi-Arch: foreign +Depends: libjs-sphinxdoc (= ${source:Version}), + libjson-perl, + ${misc:Depends}, + ${perl:Depends} +Recommends: python3-sphinx +Conflicts: python-sphinx (<< 1.1) +Replaces: python-sphinx (<< 1.1) +Provides: dh-sequence-sphinxdoc +Description: documentation generator for Python projects - common data + Sphinx is a tool for producing documentation for Python projects, using + reStructuredText as markup language. + . + This package includes manual pages, templates, translations and other data + files. + +Package: sphinx-doc +Build-Profiles: <!nodoc> +Section: doc +Architecture: all +Multi-Arch: foreign +Conflicts: python-sphinx (<< 1.1) +Replaces: python-sphinx (<< 1.1) +Depends: docutils-doc, + libjs-mathjax, + python-requests-doc, + python3-doc, + ${misc:Depends}, + ${sphinxdoc:Depends} +Description: documentation generator for Python projects - documentation + Sphinx is a tool for producing documentation for Python projects, using + reStructuredText as markup language. + . + This package includes documentation of Sphinx itself. + +Package: libjs-sphinxdoc +Section: javascript +Architecture: all +Multi-Arch: foreign +Depends: libjs-jquery (>= 1.11.1), libjs-underscore (>= 1.3.1), ${misc:Depends} +Description: JavaScript support for Sphinx documentation + Sphinx is a tool for producing documentation for Python projects, using + reStructuredText as markup language. + . + This package provides JavaScript code for documentation generated by Sphinx. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..f486ddd --- /dev/null +++ b/debian/copyright @@ -0,0 +1,119 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: Sphinx + +Files: * +Copyright: 2007-2022 the Sphinx team (see AUTHORS file) +License: BSD-2-clause + +Files: debian/dh-sphinxdoc/dh_sphinxdoc + debian/jstest/jstest.py +Copyright: 2011 Jakub Wilk <jwilk@debian.org> + 2013-2022 Dmitry Shachnev <mitya57@debian.org> +License: BSD-2-clause + +Files: sphinx/ext/apidoc.py +Copyright: 2008 Société des arts technologiques (SAT) + 2007-2022 the Sphinx team +License: BSD-2-clause + +Files: sphinx/ext/napoleon/docstring.py +Copyright: 2008 Stefan van der Walt <stefan@mentat.za.net> + 2008 Pauli Virtanen <pav@iki.fi> + 2007-2022 the Sphinx team +License: BSD-2-clause + +Files: sphinx/themes/basic/static/jquery*.js +Copyright: 2021 OpenJS Foundation and other contributors +License: Expat + +Files: sphinx/themes/basic/static/underscore*.js +Copyright: 2009-2021 Jeremy Ashkenas, Julian Gonggrijp, and DocumentCloud and Investigative Reporters & Editors +License: Expat + +Files: sphinx/search/minified-js/* + sphinx/search/non-minified-js/* +Copyright: 2001 Dr Martin Porter + 2004-2005 Richard Boulton + 2013 Yoshiki Shibukawa + 2006-2021 Olly Betts +License: BSD-3-clause + +Files: sphinx/themes/haiku/static/haiku.css_t +Copyright: 2008-2009 Haiku + 2007-2022 the Sphinx team +License: BSD-2-clause + +Files: sphinx/util/smartypants.py +Copyright: 2003 John Gruber + 2004-2007 Chad Miller + 2010 Günter Milde +License: BSD-3-clause + +License: BSD-2-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + . + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + . + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +License: BSD-3-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + . + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of the software nor the names of its contributors + may be used to endorse or promote products derived from this + software without specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +License: Expat + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + . + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + . + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/debian/dh-sphinxdoc/conf.py b/debian/dh-sphinxdoc/conf.py new file mode 100644 index 0000000..6d644b2 --- /dev/null +++ b/debian/dh-sphinxdoc/conf.py @@ -0,0 +1,3 @@ +master_doc = 'empty' +html_theme = 'classic' +html_theme_options = {'collapsiblesidebar': True} diff --git a/debian/dh-sphinxdoc/dh_sphinxdoc b/debian/dh-sphinxdoc/dh_sphinxdoc new file mode 100755 index 0000000..c297012 --- /dev/null +++ b/debian/dh-sphinxdoc/dh_sphinxdoc @@ -0,0 +1,576 @@ +#!/usr/bin/perl + +# Copyright © 2011 Jakub Wilk <jwilk@debian.org> +# © 2014-2020 Dmitry Shachnev <mitya57@debian.org> +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +=head1 NAME + +dh_sphinxdoc - helps with packaging Sphinx-generated documentation + +=head1 SYNOPSIS + +dh_sphinxdoc [S<I<debhelper options>>] [B<-X>I<item>] [I<directory>...] + +=head1 DESCRIPTION + +B<dh_sphinxdoc> is a debhelper program that prepares Sphinx-generated +documentation for inclusion in a Debian package. More specifically: + +=over 4 + +=item * + +It checks if all the files referenced by F<searchindex.js> exist. + +=item * + +It replaces known F<*.js> files with symlinks to F</usr/share/javascript/sphinxdoc/> +and generates B<${sphinxdoc:Depends}> substitution variable. + +=item * + +If the Sphinx RTD theme is used, it replaces known files from this theme with +symlinks to F</usr/share/sphinx_rtd_theme/>, and adds B<sphinx-rtd-theme-common> +to B<${sphinxdoc:Depends}>. + +=item * + +It provides a B<${sphinxdoc:Built-Using}> substitution variable, for tracking +files which could not be symlinked. Examples of such files are F<*.js> and F<*.css> +files that are generated from corresponding F<*.js_t> and F<*.css_t> templates, +and can vary depending on the used theme options (for instance, F<basic.css> file +is generated from F<basic.css_t> and is included in almost every Sphinx-generated +documentation). Currently, this variable will contain B<sphinx> and, if the default +theme is used, B<alabaster>, with their versions (other themes are not supported). + +=item * + +It removes the F<.doctrees> directory. + +=item * + +It removes the F<.buildinfo> file. + +=item * + +It removes the F<websupport.js> file. + +=back + +Note that B<dh_sphinxdoc> does not build the documentation, it only performs +the above operations when the documentation is already installed into the +package build path. To build the docs, please use L<sphinx-build(1)> command +or B<python3 -m sphinx> syntax. + +You can pass B<--with sphinxdoc> to L<dh(1)> to make it automatically call +B<dh_sphinxdoc> after B<dh_installdocs>. + +=head1 OPTIONS + +=over 4 + +=item I<directory> + +By default, B<dh_sphinxdoc> scans your package looking for directories looking +like they contain Sphinx-generated documentation. However, if you explicitly +provide one or more directories, only they will be processed. If documentation +is not found at I<directory>, an error is raised. + +=item B<-X>I<item>, B<--exclude=>I<item> + +Exclude files that contain I<item> anywhere in their filename from +being symlinked, removed or checked for existence. + +=back + +=head1 BUGS + +Symlinking translations.js is not supported. + +=cut + +use strict; +use warnings; + +use Digest::MD5; +use File::Find; +use Debian::Debhelper::Dh_Lib; +use JSON; + +my %packaged_js = (); +my @cruft_js = qw(websupport.js); + +sub md5($) +{ + my ($filename) = @_; + my $md5 = Digest::MD5->new; + open(F, '<', $filename) or error("cannot open $filename"); + $md5->addfile(*F); + close(F); + return $md5->digest; +} + +sub load_packaged_js() +{ + my %versions = (); + my $root = 'debian/libjs-sphinxdoc'; # It's tempting to use + # tmpdir('libjs-sphinxdoc') here, but it would break if the user passed + # --tmpdir to the command. + $root = '' unless -d $root; + my $path = "$root/usr/share/javascript/sphinxdoc"; + open(F, '<', "$path/index") or error("cannot open $path/index"); + while (<F>) + { + chomp; + next if /^(#|\s*$)/; + my ($js, $minver) = split(/\s+/, $_, 2); + unless (defined($minver)) + { + $js =~ m{^([0-9.]+)/} or error("syntax error in $path/index"); + $minver = $1; + } + $versions{$js} = $minver; + } + close(F); + find({ + wanted => sub { + my $js = $_; + my ($jsbase, $jsname) = m{([0-9.]+/(\S+[.]js))$} or return; + my $version = $versions{$jsbase}; + defined($version) or error("$jsbase is not in the index; is it up-to-date?"); + delete $versions{$jsbase}; + my $md5; + if (-l $js) + { + # Follow the symlink, but only if points *outside* our own directory. + my $js_target = readlink($js); + $js_target =~ m{^(/|\Q../../\E)} or return; + unless ($js_target =~ m{^/}) + { + $js_target = "$js/../$js_target"; + while ($js_target =~ s{[^./][^/]+/[.][.]/}{}) {}; + } + $md5 = md5($js_target); + } + else + { + $js =~ s{^\Q$root\E}{} unless -f $js; + $md5 = md5($js); + } + $js =~ s{^\Q$root\E}{}; + my $data = [$js, "libjs-sphinxdoc (>= $version)"]; + $packaged_js{$md5} = $data; + $packaged_js{$jsname} = $data; + }, + no_chdir => 1 + }, $path); + map { error("$path/$_ is missing") } keys(%versions); +} + +sub looks_like_sphinx_doc($) +{ + my ($path) = @_; + return 0 unless -f "$path/searchindex.js"; + return 0 unless -f "$path/search.html"; + return 1; +} + +sub looks_like_sphinx_singlehtml_doc($) +{ + my ($path) = @_; + return 0 unless -d "$path/_static"; + return 0 if -f "$path/searchindex.js"; + + # There should be exactly one HTML file in singlehtml build. + my @html_files = glob("$path/*.html"); + my @sphinx_html_files; + foreach my $html_file (@html_files) + { + open(my $fh, '<', $html_file) or error("cannot open $html_file"); + while (my $line = <$fh>) + { + if ($line =~ /<script(?: type="text\/javascript")? src="_static\/doctools.js">/) + { + push @sphinx_html_files, $html_file; + last; + } + } + } + return 0 if @sphinx_html_files != 1; + return $sphinx_html_files[0]; +} + +sub sanity_check($$) +{ + local $/; + my ($path, $singlehtml_file) = @_; + my $searchfn; + my $index; + if ($singlehtml_file) + { + # There is no search.html in singlehtml build, so we take the main HTML + # file for sanity checking and retrieving JS files. + $searchfn = $singlehtml_file; + } + else + { + my $indexfn = "$path/searchindex.js"; + open(F, '<', $indexfn) or error("cannot open $indexfn"); + $index = <F>; + close(F); + $index =~ m{^Search[.]setIndex[(](.*)[)]$} or error("$indexfn doesn't look like a Sphinx search index"); + $index = decode_json($1); + $searchfn = "$path/search.html"; + } + open(F, '<', $searchfn) or error("cannot open $searchfn"); + my $search = <F>; + close F; + $search =~ s/<!--.*?-->//g; # strip comments + my %js = (); + grep { + s/[?#].*//; + s/\s+$//; + $js{$_} = 1 unless m/^[a-z][a-z0-9.+-]*:/i or excludefile("$path/$_"); + } $search =~ m{<script(?: type="text/javascript")? src="([^"]++)"></script>}g; + my $documentation_options; + for my $line (split /^/, $search) + { + if ($line =~ "_static/documentation_options.js") + { + my $documentation_options_fn = "$path/_static/documentation_options.js"; + open(my $fh, '<', $documentation_options_fn) or error("cannot open $documentation_options_fn"); + $documentation_options = <$fh>; + close $fh; + } + if ($line =~ "var DOCUMENTATION_OPTIONS =") + { + $documentation_options = $search; + } + } + defined $documentation_options or error("DOCUMENTATION_OPTIONS not found"); + my $loads_searchindex = $search =~ m{<script(?: type="text/javascript")? src="[^"]*searchindex.js\s?"(?: defer)?>}; + unless ($loads_searchindex) + { + # old style, used before Sphinx 2.0 + $loads_searchindex = $search =~ m/\QjQuery(function() { Search.loadIndex("\E/; + } + my ($has_source) = $documentation_options =~ m{HAS_SOURCE:\s*(true|false)}; + my ($sourcelink_suffix) = $documentation_options =~ m{SOURCELINK_SUFFIX:\s*'([^']*)'}; + $sourcelink_suffix = ".txt" unless defined $sourcelink_suffix; + my $url_root; + if ($documentation_options =~ /\QURL_ROOT: document.getElementById("documentation_options")\E/) + { + ($url_root) = $search =~ m{data-url_root="([^"]*)"}; + } + else + { + ($url_root) = $documentation_options =~ m{URL_ROOT:\s*'([^']*)'}; + } + %js or error("$searchfn does not include any JavaScript code"); + $singlehtml_file or $loads_searchindex or error("$searchfn does not load searchindex.js"); + defined $has_source or error("DOCUMENTATION_OPTIONS does not define HAS_SOURCE"); + defined $url_root or error("DOCUMENTATION_OPTIONS does not define URL_ROOT"); + $has_source = $has_source eq 'true'; + $url_root =~ m{^([a-z]+:/)?/} and error("URL_ROOT in $searchfn is not relative"); + for my $js (keys(%js)) + { + -f "$path/$js" or -l "$path/$js" or error("$path/$js is missing"); + } + unless ($singlehtml_file) + { + my $pages = $index->{"filenames"}; + for my $page (@$pages) + { + # Append sourcelink_suffix if the page name does not already end with it. + (my $sourcepage = $page) =~ s/(?<!$sourcelink_suffix)$/$sourcelink_suffix/; + -f "$path/_sources/$sourcepage" + or excludefile("$path/_sources/$sourcepage") + or error("$path/_sources/$sourcepage is missing") + if $has_source; + # Get the page basename before appending .html. + $page =~ s/\.[a-z]+$//; + -f "$path/$page.html" + or excludefile("$path/$page.html") + or error("$path/$page.html is missing"); + } + } + if (opendir(D, "$path/_static/")) + { + grep { + $js{"_static/$_"} = 1 + if /[.]js$/ and not excludefile("$path/_static/$_"); + } readdir(D); + closedir(D); + } + return keys(%js); +} + +sub unknown_javascript($) +{ + my ($js) = @_; + my $message = "unknown JavaScript code: $js"; + $js =~ s{.*/}{}; + my $basic = grep { $_ eq $js } qw(searchtools.js doctools.js jquery.js underscore.js); + my $cruft = grep { $_ eq $js } @cruft_js; + my $basic_ignored = grep { $_ eq $js } qw(theme.js documentation_options.js language_data.js sidebar.js searchindex.js); + if ($basic) + { + error("error: $message"); + } + elsif (not $cruft and not $basic_ignored) + { + warning("ignoring $message"); + } +} + +sub ln_sf($$) +{ + my ($orig_target, $orig_source) = my ($target, $source) = @_; + $source =~ s{^debian/[^/]++/+}{} or die; + $target =~ s{^/++}{} or die; + my @source = split(m{/++}, $source); + my @target = split(m{/++}, $target); + @source > 0 and @target > 0 or die; + if ($source[0] eq $target[0]) + { + # Make the symlink relative, as per Policy 10.5. + while (@source > 0 and @target > 0 and $source[0] eq $target[0]) + { + shift @source; + shift @target; + } + $target = ('../' x $#source) . join('/', @target); + } + else + { + # Keep the symlink absolute, as per Policy 10.5. + $target = $orig_target; + } + doit('ln', '-sf', $target, $orig_source); +} + +sub fix_symlinks($@) +{ + my %deps = (); + my ($path, @js) = @_; + for my $js (@js) + { + my $id = ''; + if (-l "$path/$js") + { + my $symlink_target = readlink("$path/$js"); + $symlink_target =~ m{/sphinxdoc/} and next; + $symlink_target =~ m{/javascript/\w+/(\w+)([.](min|lite|pack))?[.]js$} and $id = "$1.js"; + } + elsif (-f "$path/$js") + { + $id = md5("$path/$js"); + } + if (exists $packaged_js{$id}) + { + my ($target, $dependency) = @{$packaged_js{$id}}; + ln_sf($target, "$path/$js"); + $deps{$dependency} = 1; + } + else + { + unknown_javascript("$path/$js"); + } + } + return keys %deps; +} + +sub drop_cruft($) +{ + my ($path) = @_; + my $doctrees = "$path/.doctrees"; + my $buildinfo = "$path/.buildinfo"; + if (-d $doctrees and not excludefile($doctrees)) + { + doit('rm', '-rf', $doctrees); + } + if (-f $buildinfo and not excludefile($buildinfo)) + { + doit('rm', '-f', $buildinfo); + } + foreach my $js (@cruft_js) + { + my $js = "$path/_static/$js"; + if (-f $js and not excludefile($js)) + { + doit('rm', '-f', $js) if -f $js; + } + } +} + +sub process_rtd($) +{ + my ($path) = @_; + my $theme_is_rtd = 0; + if (-d "$path/_static/js" and -f "$path/_static/js/theme.js") + { + if (open(F, '<', "$path/_static/js/theme.js")) + { + while (my $line = <F>) { + if (index($line, "window.SphinxRtdTheme") != -1) + { + $theme_is_rtd = 1; + last; + } + } + close(F); + } + } + + my @deps; + my $target_dir = "/usr/share/sphinx_rtd_theme/static"; + if ($theme_is_rtd and -d $target_dir) + { + find({ + wanted => sub { + return if -d; + my $filename = $_; + substr($filename, 0, 1 + length $target_dir) = ""; + return unless -f "$path/_static/$filename"; + ln_sf($_, "$path/_static/$filename"); + }, + no_chdir => 1 + }, $target_dir); + + my $rtd_theme_version = get_installed_package_version("sphinx-rtd-theme-common"); + $rtd_theme_version =~ s/-[^-]+$//; # Remove the Debian version suffix + push @deps, "sphinx-rtd-theme-common (>= $rtd_theme_version)"; + } + return @deps; +} + +sub get_installed_package_version($) +{ + my ($package_name) = @_; + return `dpkg-query -W -f '\${Version}' $package_name 2>/dev/null`; +} + +sub list_built_using($) +{ + my ($path) = @_; + my @built_using; + my $sphinx_version = get_installed_package_version("sphinx-common"); + push @built_using, "sphinx (= $sphinx_version)"; + if (-d "$path/_static" and -f "$path/_static/alabaster.css") + { + my $alabaster_version = get_installed_package_version("python3-alabaster"); + if ($alabaster_version) + { + push @built_using, "alabaster (= $alabaster_version)"; + } + } + return @built_using; +} + +sub fix_sphinx_doc($$) +{ + my ($package, $path) = @_; + my $is_html = looks_like_sphinx_doc($path); + my $singlehtml_file = looks_like_sphinx_singlehtml_doc($path); + return 0 if not ($is_html or $singlehtml_file); + my @js = sanity_check($path, $singlehtml_file); + my @rtd_deps = process_rtd($path); + my @deps = fix_symlinks($path, @js); + my @built_using = list_built_using($path); + drop_cruft($path); + map { addsubstvar($package, "sphinxdoc:Depends", $_) } @deps; + map { addsubstvar($package, "sphinxdoc:Depends", $_) } @rtd_deps; + map { addsubstvar($package, "sphinxdoc:Built-Using", $_) } @built_using; + return 1; +} + +init(); + +load_packaged_js(); + +my @paths = @ARGV; +@paths = (undef) unless @paths; + +foreach my $path (@paths) +{ + my $done = 0; + my @matching_packages; + foreach my $package (@{$dh{DOPACKAGES}}) + { + my $pkgpath = tmpdir($package); + if (defined $path) + { + next if -l $path; + $pkgpath .= "/$path"; + next unless -d $pkgpath; + push @matching_packages, $package; + $done += fix_sphinx_doc($package, $pkgpath); + } + else + { + $pkgpath .= '/usr/share/doc/'; + next unless -d $pkgpath; + find({ + wanted => sub { + return unless -d; + return if -l; + return if excludefile($_); + $done += fix_sphinx_doc($package, $_); + }, + no_chdir => 1 + }, $pkgpath); + } + } + if ($done == 0) + { + if (defined $path) + { + if (!@matching_packages) + { + error("Path $path not found in any built package\n(searched in: @{$dh{DOPACKAGES}})"); + } + error("Sphinx documentation not found at $path\n(path found in packages: @matching_packages)"); + } + else + { + warning("Sphinx documentation not found"); + } + } +} + +=head1 SEE ALSO + +L<debhelper(7)>, L<dh(1)>. + +This program is meant to be used together with debhelper. + +=head1 AUTHOR + +Jakub Wilk <jwilk@debian.org> + +=cut + +# vim:ts=4 sw=4 et diff --git a/debian/dh-sphinxdoc/empty.rst b/debian/dh-sphinxdoc/empty.rst new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/debian/dh-sphinxdoc/empty.rst diff --git a/debian/dh-sphinxdoc/index b/debian/dh-sphinxdoc/index new file mode 100644 index 0000000..ab0ff40 --- /dev/null +++ b/debian/dh-sphinxdoc/index @@ -0,0 +1,11 @@ +# <filename> [min-version] +1.0/doctools.js 5.2 +1.0/jquery.js +1.0/language_data.js 2.4.3-5~ +1.0/searchtools.js 5.2 +1.0/sidebar.js 5.0 +1.0/theme_extras.js 5.0 +1.0/underscore.js +1.0/css3-mediaqueries.js 1.3 +1.0/_sphinx_javascript_frameworks_compat.js 5.0 +1.0/sphinx_highlight.js 5.2 diff --git a/debian/dh-sphinxdoc/install-js b/debian/dh-sphinxdoc/install-js new file mode 100755 index 0000000..cf4ceac --- /dev/null +++ b/debian/dh-sphinxdoc/install-js @@ -0,0 +1,22 @@ +#!/bin/sh + +set -e -u + +if [ $# -eq 0 ] +then + printf 'Usage: %s <target-directory>\n' "$0" >&2 + exit 1 +fi + +here="$(dirname "$0")" +rm -rf "$here/tmp/" +python3 ./sphinx/cmd/build.py -T -b html "$here" "$here/tmp" +cp -f "sphinx/themes/bizstyle/static/css3-mediaqueries.js" "$1" +cp -f "sphinx/themes/scrolls/static/theme_extras.js" "$1" +cp -f "$here/tmp/_static/doctools.js" "$1" +cp -f "$here/tmp/_static/language_data.js" "$1" +cp -f "$here/tmp/_static/sidebar.js" "$1" +cp -f "$here/tmp/_static/searchtools.js" "$1" +rm -rf "$here/tmp/" + +# vim:ts=4 sw=4 et diff --git a/debian/dh-sphinxdoc/sphinxdoc.pm b/debian/dh-sphinxdoc/sphinxdoc.pm new file mode 100644 index 0000000..3b777e3 --- /dev/null +++ b/debian/dh-sphinxdoc/sphinxdoc.pm @@ -0,0 +1,8 @@ +use warnings; +use strict; + +use Debian::Debhelper::Dh_Lib; + +insert_after('dh_installdocs', 'dh_sphinxdoc'); + +1; diff --git a/debian/gbp.conf b/debian/gbp.conf new file mode 100644 index 0000000..3879982 --- /dev/null +++ b/debian/gbp.conf @@ -0,0 +1,2 @@ +[DEFAULT] +debian-branch=debian/master diff --git a/debian/jstest/jstest.py b/debian/jstest/jstest.py new file mode 100644 index 0000000..d1fbd59 --- /dev/null +++ b/debian/jstest/jstest.py @@ -0,0 +1,153 @@ +#!/usr/bin/python3 +# encoding=UTF-8 + +# Copyright © 2011 Jakub Wilk <jwilk@debian.org> +# © 2013-2022 Dmitry Shachnev <mitya57@debian.org> +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +import urllib.parse +import urllib.request +import re +import unittest +import gi + +gi.require_version('Gtk', '4.0') +gi.require_version('WebKit', '6.0') +from gi.repository import GLib, Gtk, WebKit + +default_time_limit = 40.0 + +# HTTP browser +# ============ + +class Timeout(Exception): + pass + +class Browser(object): + + def __init__(self, options): + settings = WebKit.Settings() + settings.set_property('allow-file-access-from-file-urls', True) + settings.set_property('enable-write-console-messages-to-stdout', True) + self._time_limit = 0 + self._view = WebKit.WebView(settings=settings) + self._view.connect('notify::title', self._on_title_changed) + self._result = None + self._id = 0 + self._application = Gtk.Application() + self._application.set_application_id('org.debian.sphinx.jstest') + self._application.connect('activate', self._activate) + + def _activate(self, application): + self._window = Gtk.ApplicationWindow(application=application) + self._window.set_child(self._view) + self._window.show() + + def _on_title_changed(self, webview, user_data): + contents = webview.get_property('title') + webview.evaluate_javascript('document.title = ""', -1) + found = re.match(r"(?P<n_results>\d+) (?P<n_links>\d+) (?P<n_highlights>\d+)", contents) + if found: + self._result = found.groupdict() + self._window.destroy() + GLib.source_remove(self._id) + self._id = 0 + + def _quit(self): + self._view.evaluate_javascript( + "var n_results = $('#search-results > p:first').text().match(/found (\d+) page/)[1];\n" + "var n_links = $('#search-results a').length;\n" + "var n_highlights = $('#search-results .highlighted').length;\n" + "document.title = `${n_results} ${n_links} ${n_highlights}`;", + -1, + ) + if self._time_limit < 0: + self._result = None + self._window.destroy() + return GLib.SOURCE_REMOVE + + self._time_limit -= 1 + return GLib.SOURCE_CONTINUE + + def wget(self, url, time_limit=default_time_limit): + self._view.load_uri(url) + self._time_limit = time_limit + self._id = GLib.timeout_add_seconds(1, self._quit) + self._application.run() + if self._result is None: + raise Timeout + return self._result + + +# Actual tests +# ============ + +def test_html(result, options): + + class TestCase(unittest.TestCase): + + if options.n_results is not None: + def test_n_results(self): + n_results = int(result['n_results']) + self.assertEqual(n_results, options.n_results) + + if options.n_links is not None: + def test_n_links(self): + n_links = int(result['n_links']) + self.assertEqual(n_links, options.n_links) + + if options.n_highlights is not None: + def test_n_highlights(self): + n_highlights = int(result['n_highlights']) + self.assertEqual(n_highlights, options.n_highlights) + + TestCase.__name__ = 'TestCase(%r)' % options.search_term + + suite = unittest.TestLoader().loadTestsFromTestCase(TestCase) + return unittest.TextTestRunner(verbosity=2).run(suite) + +def test_directory(directory, options, time_limit=default_time_limit): + url = urllib.parse.urljoin('file:', urllib.request.pathname2url(directory)) + url = urllib.parse.urljoin(url, 'html/search.html?q=' + urllib.parse.quote_plus(options.search_term)) + browser = Browser(options) + result = browser.wget(url, time_limit) + return test_html(result, options) + +def main(): + import argparse + parser = argparse.ArgumentParser() + parser.add_argument('--time-limit', type=float, default=default_time_limit) + parser.add_argument('directory', metavar='DIRECTORY') + parser.add_argument('search_term', metavar='SEARCH-TERM') + parser.add_argument('--n-results', type=int) + parser.add_argument('--n-links', type=int) + parser.add_argument('--n-highlights', type=int) + options = parser.parse_args() + test_directory(options.directory, options=options, time_limit=options.time_limit) + +if __name__ == '__main__': + main() + +# vim:ts=4 sw=4 et diff --git a/debian/jstest/run-tests b/debian/jstest/run-tests new file mode 100755 index 0000000..95ab1e8 --- /dev/null +++ b/debian/jstest/run-tests @@ -0,0 +1,37 @@ +#!/usr/bin/python3 + +import os +import sys + +import jstest + +class t1: + search_term = 'example' + n_results = 83 + n_links = 83 + n_highlights = 98 + +class t2: + search_term = 'examples' + n_results = 74 + n_links = 74 + n_highlights = 17 + +class t3: + search_term = 'graph' + n_results = 33 + n_links = 33 + n_highlights = 125 + +if __name__ == '__main__': + if not os.getenv('DISPLAY'): + raise RuntimeError('These tests require access to an X server') + [build_directory] = sys.argv[1:] + build_directory = os.path.abspath(build_directory) + n_failures = 0 + for testcase in t1, t2, t3: + failures = jstest.test_directory(build_directory, testcase).failures + n_failures += len(failures) + sys.exit(n_failures > 0) + +# vim:ts=4 sw=4 et diff --git a/debian/libjs-sphinxdoc.dirs b/debian/libjs-sphinxdoc.dirs new file mode 100644 index 0000000..60fd8e3 --- /dev/null +++ b/debian/libjs-sphinxdoc.dirs @@ -0,0 +1 @@ +/usr/share/javascript/sphinxdoc/1.0/ diff --git a/debian/libjs-sphinxdoc.install b/debian/libjs-sphinxdoc.install new file mode 100644 index 0000000..5eaa069 --- /dev/null +++ b/debian/libjs-sphinxdoc.install @@ -0,0 +1 @@ +debian/dh-sphinxdoc/index /usr/share/javascript/sphinxdoc/ diff --git a/debian/libjs-sphinxdoc.links b/debian/libjs-sphinxdoc.links new file mode 100644 index 0000000..bd6705b --- /dev/null +++ b/debian/libjs-sphinxdoc.links @@ -0,0 +1,2 @@ +/usr/share/javascript/jquery/jquery.js /usr/share/javascript/sphinxdoc/1.0/jquery.js +/usr/share/javascript/underscore/underscore.js /usr/share/javascript/sphinxdoc/1.0/underscore.js diff --git a/debian/patches/disable_js_version_check.diff b/debian/patches/disable_js_version_check.diff new file mode 100644 index 0000000..a59f03b --- /dev/null +++ b/debian/patches/disable_js_version_check.diff @@ -0,0 +1,21 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Thu, 8 Oct 2015 13:58:04 -0700 +Subject: disable a test that checks versions of JS libraries + +Forwarded: not-needed +--- + tests/test_theming.py | 1 + + 1 file changed, 1 insertion(+) + +diff --git a/tests/test_theming.py b/tests/test_theming.py +index 21382d8..2a3b027 100644 +--- a/tests/test_theming.py ++++ b/tests/test_theming.py +@@ -57,6 +57,7 @@ def test_theme_api(app, status, warning): + assert not os.path.exists(themedir) + + ++@pytest.mark.skip('In Debian we use packaged JS libraries') + @pytest.mark.sphinx(testroot='tocdepth') # a minimal root + def test_js_source(app, status, warning): + # Now sphinx provides non-minified JS files for jquery.js and underscore.js diff --git a/debian/patches/highlight_search_terms.diff b/debian/patches/highlight_search_terms.diff new file mode 100644 index 0000000..5aa9159 --- /dev/null +++ b/debian/patches/highlight_search_terms.diff @@ -0,0 +1,120 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Sun, 23 Oct 2022 22:38:55 +0300 +Subject: Highlight all search terms on search results page + +SphinxHighlight.highlightSearchWords() is called on DOMContentLoaded +event, and it will not highlight page fragments loaded asynchronously. + +So we should highlight all such fragments manually. + +Forwarded: https://github.com/sphinx-doc/sphinx/pull/10930 +--- + sphinx/themes/basic/static/searchtools.js | 20 ++++++++++++++------ + sphinx/themes/basic/static/sphinx_highlight.js | 20 ++++++++++++++------ + 2 files changed, 28 insertions(+), 12 deletions(-) + +diff --git a/sphinx/themes/basic/static/searchtools.js b/sphinx/themes/basic/static/searchtools.js +index 8279279..0b5537f 100644 +--- a/sphinx/themes/basic/static/searchtools.js ++++ b/sphinx/themes/basic/static/searchtools.js +@@ -57,7 +57,7 @@ const _removeChildren = (element) => { + const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +-const _displayItem = (item, searchTerms) => { ++const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; +@@ -86,9 +86,15 @@ const _displayItem = (item, searchTerms) => { + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; +- if (descr) ++ const rehighlightListItem = () => window.setTimeout(() => { ++ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js ++ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); ++ }, 10); ++ if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; ++ rehighlightListItem(); ++ } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) +@@ -97,6 +103,7 @@ const _displayItem = (item, searchTerms) => { + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms) + ); ++ rehighlightListItem(); + }); + Search.output.appendChild(listItem); + }; +@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => { + const _displayNextItem = ( + results, + resultCount, +- searchTerms ++ searchTerms, ++ highlightTerms, + ) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { +- _displayItem(results.pop(), searchTerms); ++ _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( +- () => _displayNextItem(results, resultCount, searchTerms), ++ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } +@@ -360,7 +368,7 @@ const Search = { + // console.info("search results:", Search.lastresults); + + // print the results +- _displayNextItem(results, results.length, searchTerms); ++ _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** +diff --git a/sphinx/themes/basic/static/sphinx_highlight.js b/sphinx/themes/basic/static/sphinx_highlight.js +index aae669d..5fbd3ce 100644 +--- a/sphinx/themes/basic/static/sphinx_highlight.js ++++ b/sphinx/themes/basic/static/sphinx_highlight.js +@@ -29,14 +29,16 @@ const _highlight = (node, addItems, text, className) => { + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); ++ const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, +- parent.insertBefore( +- document.createTextNode(val.substr(pos + text.length)), +- node.nextSibling +- ) ++ parent.insertBefore(rest, node.nextSibling) + ); + node.nodeValue = val.substr(0, pos); ++ /* There may be more occurrences of search term in this node. So call this ++ * function recursively on the remaining fragment. ++ */ ++ _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( +@@ -140,5 +142,11 @@ const SphinxHighlight = { + }, + }; + +-_ready(SphinxHighlight.highlightSearchWords); +-_ready(SphinxHighlight.initEscapeListener); ++_ready(() => { ++ /* Do not call highlightSearchWords() when we are on the search page. ++ * It will highlight words from the _previous_ search query. ++ */ ++ if (typeof Search === "undefined") ++ SphinxHighlight.highlightSearchWords(); ++ SphinxHighlight.initEscapeListener(); ++}); diff --git a/debian/patches/intersphinx_local.diff b/debian/patches/intersphinx_local.diff new file mode 100644 index 0000000..ba86960 --- /dev/null +++ b/debian/patches/intersphinx_local.diff @@ -0,0 +1,51 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Tue, 2 Jun 2020 12:22:52 +0300 +Subject: Use local intersphinx inventory + +To prevent Sphinx from downloading https://docs.python.org/3/objects.inv +during build. +--- + doc/conf.py | 5 ++--- + doc/tutorial/deploying.rst | 9 ++++++--- + 2 files changed, 8 insertions(+), 6 deletions(-) + +diff --git a/doc/conf.py b/doc/conf.py +index d24ef11..74be5b5 100644 +--- a/doc/conf.py ++++ b/doc/conf.py +@@ -118,9 +118,8 @@ texinfo_documents = [ + ] + + intersphinx_mapping = { +- 'python': ('https://docs.python.org/3/', None), +- 'requests': ('https://requests.readthedocs.io/en/latest/', None), +- 'readthedocs': ('https://docs.readthedocs.io/en/stable', None), ++ 'python': ('/usr/share/doc/python3-doc/html', None), ++ 'requests': ('/usr/share/doc/python-requests-doc/html', None), + } + + # Sphinx document translation with sphinx gettext feature uses these settings: +diff --git a/doc/tutorial/deploying.rst b/doc/tutorial/deploying.rst +index 76b68c3..619b502 100644 +--- a/doc/tutorial/deploying.rst ++++ b/doc/tutorial/deploying.rst +@@ -160,13 +160,16 @@ Read the Docs + ~~~~~~~~~~~~~ + + `Read the Docs`_ offers integration with both GitHub and GitLab. The quickest +-way of getting started is to follow :doc:`the RTD +-tutorial <readthedocs:tutorial/index>`, which is loosely based on this one. ++way of getting started is to follow `the RTD tutorial`_, which is loosely ++based on this one. + You can publish your sources on GitHub as explained :ref:`in the previous + section <publishing-sources>`, then skip directly to +-:ref:`readthedocs:tutorial/index:Sign up for Read the Docs`. ++`Sign up for Read the Docs`_. + If you choose GitLab instead, the process is similar. + ++.. _the RTD tutorial: https://docs.readthedocs.io/en/stable/tutorial/index.html ++.. _Sign up for Read the Docs: https://docs.readthedocs.io/en/stable/tutorial/index.html#sign-up-for-read-the-docs ++ + GitHub Pages + ~~~~~~~~~~~~ + diff --git a/debian/patches/move_sphinxcontrib_to_extras_require.diff b/debian/patches/move_sphinxcontrib_to_extras_require.diff new file mode 100644 index 0000000..574255a --- /dev/null +++ b/debian/patches/move_sphinxcontrib_to_extras_require.diff @@ -0,0 +1,40 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Fri, 7 Feb 2020 13:59:30 +0300 +Subject: Move sphinxcontrib modules to extras_require + +--- + pyproject.toml | 14 ++++++++------ + 1 file changed, 8 insertions(+), 6 deletions(-) + +diff --git a/pyproject.toml b/pyproject.toml +index 0e059b5..7532268 100644 +--- a/pyproject.toml ++++ b/pyproject.toml +@@ -57,12 +57,6 @@ classifiers = [ + "Topic :: Utilities", + ] + dependencies = [ +- "sphinxcontrib-applehelp", +- "sphinxcontrib-devhelp", +- "sphinxcontrib-jsmath", +- "sphinxcontrib-htmlhelp>=2.0.0", +- "sphinxcontrib-serializinghtml>=1.1.5", +- "sphinxcontrib-qthelp", + "Jinja2>=3.0", + "Pygments>=2.12", + "docutils>=0.14,<0.20", +@@ -99,6 +93,14 @@ test = [ + "typed_ast; python_version < '3.8'", + "cython", + ] ++sphinxcontrib = [ ++ "sphinxcontrib-applehelp", ++ "sphinxcontrib-devhelp", ++ "sphinxcontrib-jsmath", ++ "sphinxcontrib-htmlhelp>=2.0.0", ++ "sphinxcontrib-serializinghtml>=1.1.5", ++ "sphinxcontrib-qthelp", ++] + + [[project.authors]] + name = "Georg Brandl" diff --git a/debian/patches/no_external_css.diff b/debian/patches/no_external_css.diff new file mode 100644 index 0000000..697de83 --- /dev/null +++ b/debian/patches/no_external_css.diff @@ -0,0 +1,21 @@ +From: Chris Lamb <lamby@debian.org> +Date: Sat, 14 Apr 2018 10:10:45 +0100 +Subject: Don't use Google Fonts to avoid privacy breach. + +--- + sphinx/themes/pyramid/layout.html | 2 -- + 1 file changed, 2 deletions(-) + +diff --git a/sphinx/themes/pyramid/layout.html b/sphinx/themes/pyramid/layout.html +index ffa9313..19f351d 100644 +--- a/sphinx/themes/pyramid/layout.html ++++ b/sphinx/themes/pyramid/layout.html +@@ -1,8 +1,6 @@ + {%- extends "basic/layout.html" %} + + {%- block extrahead %} +-<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> +-<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" /> + <!--[if lte IE 6]> + <link rel="stylesheet" href="{{ pathto('_static/ie6.css', 1) }}" type="text/css" media="screen" charset="utf-8" /> + <![endif]--> diff --git a/debian/patches/pygments_2.14.diff b/debian/patches/pygments_2.14.diff new file mode 100644 index 0000000..f08b49b --- /dev/null +++ b/debian/patches/pygments_2.14.diff @@ -0,0 +1,111 @@ +From: Adam Turner <9087854+aa-turner@users.noreply.github.com> +Date: Sun, 1 Jan 2023 19:17:03 +0000 +Subject: Fix tests for Pygments 2.14 + +Pygments 2.14 was released on 01/01/2023 [0] + +[0]: https://pygments.org/docs/changelog/#version-2-14-0 + +(cherry picked from commit 965768bfda2a00ba6466cdb12a7a46efdce47023) +--- + pyproject.toml | 2 +- + tests/test_ext_viewcode.py | 27 +++++++++++++++++++-------- + tests/test_intl.py | 11 +++++++++-- + 3 files changed, 29 insertions(+), 11 deletions(-) + +diff --git a/pyproject.toml b/pyproject.toml +index 7532268..06e5e45 100644 +--- a/pyproject.toml ++++ b/pyproject.toml +@@ -58,7 +58,7 @@ classifiers = [ + ] + dependencies = [ + "Jinja2>=3.0", +- "Pygments>=2.12", ++ "Pygments>=2.13", + "docutils>=0.14,<0.20", + "snowballstemmer>=2.0", + "babel>=2.9", +diff --git a/tests/test_ext_viewcode.py b/tests/test_ext_viewcode.py +index 7750b8d..6d443d1 100644 +--- a/tests/test_ext_viewcode.py ++++ b/tests/test_ext_viewcode.py +@@ -2,6 +2,7 @@ + + import re + ++import pygments + import pytest + + +@@ -31,14 +32,24 @@ def test_viewcode(app, status, warning): + + result = (app.outdir / '_modules/spam/mod1.html').read_text(encoding='utf8') + result = re.sub('<span class=".*?">', '<span>', result) # filter pygments classes +- assert ('<div class="viewcode-block" id="Class1"><a class="viewcode-back" ' +- 'href="../../index.html#spam.Class1">[docs]</a>' +- '<span>@decorator</span>\n' +- '<span>class</span> <span>Class1</span>' +- '<span>(</span><span>object</span><span>):</span>\n' +- ' <span>"""</span>\n' +- '<span> this is Class1</span>\n' +- '<span> """</span></div>\n') in result ++ if pygments.__version__ >= '2.14.0': ++ assert ('<div class="viewcode-block" id="Class1"><a class="viewcode-back" ' ++ 'href="../../index.html#spam.Class1">[docs]</a>' ++ '<span>@decorator</span>\n' ++ '<span>class</span> <span>Class1</span>' ++ '<span>(</span><span>object</span><span>):</span>\n' ++ '<span> </span><span>"""</span>\n' ++ '<span> this is Class1</span>\n' ++ '<span> """</span></div>\n') in result ++ else: ++ assert ('<div class="viewcode-block" id="Class1"><a class="viewcode-back" ' ++ 'href="../../index.html#spam.Class1">[docs]</a>' ++ '<span>@decorator</span>\n' ++ '<span>class</span> <span>Class1</span>' ++ '<span>(</span><span>object</span><span>):</span>\n' ++ ' <span>"""</span>\n' ++ '<span> this is Class1</span>\n' ++ '<span> """</span></div>\n') in result + + + @pytest.mark.sphinx('epub', testroot='ext-viewcode') +diff --git a/tests/test_intl.py b/tests/test_intl.py +index 796d95b..956352c 100644 +--- a/tests/test_intl.py ++++ b/tests/test_intl.py +@@ -7,6 +7,7 @@ import os + import re + + import docutils ++import pygments + import pytest + from babel.messages import mofile, pofile + from babel.messages.catalog import Catalog +@@ -1105,8 +1106,11 @@ def test_additional_targets_should_not_be_translated(app): + expected_expr = ("""<span class="n">literal</span>""" + """<span class="o">-</span>""" + """<span class="n">block</span>\n""" +- """<span class="k">in</span> """ ++ """<span class="k">in</span>""" ++ """<span class="w"> </span>""" + """<span class="n">list</span>""") ++ if pygments.__version__ < '2.14.0': ++ expected_expr = expected_expr.replace("""<span class="w"> </span>""", ' ') + assert_count(expected_expr, result, 1) + + # doctest block should not be translated but be highlighted +@@ -1184,8 +1188,11 @@ def test_additional_targets_should_be_translated(app): + expected_expr = ("""<span class="no">LITERAL</span>""" + """<span class="o">-</span>""" + """<span class="no">BLOCK</span>\n""" +- """<span class="no">IN</span> """ ++ """<span class="no">IN</span>""" ++ """<span class="w"> </span>""" + """<span class="no">LIST</span>""") ++ if pygments.__version__ < '2.14.0': ++ expected_expr = expected_expr.replace("""<span class="w"> </span>""", ' ') + assert_count(expected_expr, result, 1) + + # doctest block should not be translated but be highlighted diff --git a/debian/patches/remove_contrib_references.diff b/debian/patches/remove_contrib_references.diff new file mode 100644 index 0000000..f22bf0a --- /dev/null +++ b/debian/patches/remove_contrib_references.diff @@ -0,0 +1,98 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Wed, 25 Dec 2019 23:18:56 +0300 +Subject: Remove references to sphinxcontrib modules + +They are not packaged yet, and when they are, we would want to avoid +dependency loops anyway. +--- + doc/usage/builders/index.rst | 24 ------------------------ + sphinx/application.py | 6 ------ + sphinx/builders/html/__init__.py | 2 -- + 3 files changed, 32 deletions(-) + +diff --git a/doc/usage/builders/index.rst b/doc/usage/builders/index.rst +index 4d53152..4f7bdb6 100644 +--- a/doc/usage/builders/index.rst ++++ b/doc/usage/builders/index.rst +@@ -68,12 +68,6 @@ The builder's "name" must be given to the **-b** command-line option of + also generates HTML Help support files that allow the Microsoft HTML Help + Workshop to compile them into a CHM file. + +- .. autoattribute:: name +- +- .. autoattribute:: format +- +- .. autoattribute:: supported_image_types +- + .. module:: sphinxcontrib.qthelp + .. class:: QtHelpBuilder + +@@ -85,12 +79,6 @@ The builder's "name" must be given to the **-b** command-line option of + + Moved to sphinxcontrib.qthelp from sphinx.builders package. + +- .. autoattribute:: name +- +- .. autoattribute:: format +- +- .. autoattribute:: supported_image_types +- + .. _Qt help: https://doc.qt.io/qt-4.8/qthelp-framework.html + + .. module:: sphinxcontrib.applehelp +@@ -111,12 +99,6 @@ The builder's "name" must be given to the **-b** command-line option of + output will not be valid until :program:`hiutil` has been run on all of the + ``.lproj`` folders within the bundle. + +- .. autoattribute:: name +- +- .. autoattribute:: format +- +- .. autoattribute:: supported_image_types +- + .. versionadded:: 1.3 + + .. versionchanged:: 2.0 +@@ -130,12 +112,6 @@ The builder's "name" must be given to the **-b** command-line option of + also generates `GNOME Devhelp <https://wiki.gnome.org/Apps/Devhelp>`__ + support file that allows the GNOME Devhelp reader to view them. + +- .. autoattribute:: name +- +- .. autoattribute:: format +- +- .. autoattribute:: supported_image_types +- + .. versionchanged:: 2.0 + + Moved to sphinxcontrib.devhelp from sphinx.builders package. +diff --git a/sphinx/application.py b/sphinx/application.py +index 10c03a2..c83fcc2 100644 +--- a/sphinx/application.py ++++ b/sphinx/application.py +@@ -99,12 +99,6 @@ builtin_extensions = ( + 'sphinx.environment.collectors.metadata', + 'sphinx.environment.collectors.title', + 'sphinx.environment.collectors.toctree', +- # 1st party extensions +- 'sphinxcontrib.applehelp', +- 'sphinxcontrib.devhelp', +- 'sphinxcontrib.htmlhelp', +- 'sphinxcontrib.serializinghtml', +- 'sphinxcontrib.qthelp', + # Strictly, alabaster theme is not a builtin extension, + # but it is loaded automatically to use it as default theme. + 'alabaster', +diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py +index 4fe40eb..861232e 100644 +--- a/sphinx/builders/html/__init__.py ++++ b/sphinx/builders/html/__init__.py +@@ -1350,8 +1350,6 @@ def deprecate_html_4(_app: Sphinx, config: Config) -> None: + + + # for compatibility +-import sphinxcontrib.serializinghtml # NOQA +- + import sphinx.builders.dirhtml # NOQA + import sphinx.builders.singlehtml # NOQA + diff --git a/debian/patches/series b/debian/patches/series new file mode 100644 index 0000000..5bc8b97 --- /dev/null +++ b/debian/patches/series @@ -0,0 +1,12 @@ +disable_js_version_check.diff +skip_tests_network.diff +no_external_css.diff +remove_contrib_references.diff +skip_tests_jsmath.diff +use_packaged_mathjax.diff +skip_tests_serializinghtml.diff +move_sphinxcontrib_to_extras_require.diff +intersphinx_local.diff +support_old_search_indexes.diff +highlight_search_terms.diff +pygments_2.14.diff diff --git a/debian/patches/skip_tests_jsmath.diff b/debian/patches/skip_tests_jsmath.diff new file mode 100644 index 0000000..faf04e4 --- /dev/null +++ b/debian/patches/skip_tests_jsmath.diff @@ -0,0 +1,36 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Wed, 25 Dec 2019 23:37:50 +0300 +Subject: Skip tests that require sphinxcontrib.jsmath module + +--- + tests/test_build_html.py | 3 +++ + 1 file changed, 3 insertions(+) + +diff --git a/tests/test_build_html.py b/tests/test_build_html.py +index 1796dc0..8a74a68 100644 +--- a/tests/test_build_html.py ++++ b/tests/test_build_html.py +@@ -1528,6 +1528,7 @@ def test_html_math_renderer_is_imgmath(app, status, warning): + assert app.builder.math_renderer_name == 'imgmath' + + ++@pytest.mark.skip('Requires sphinxcontrib.jsmath module') + @pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinxcontrib.jsmath', + 'sphinx.ext.imgmath']}) +@@ -1549,6 +1550,7 @@ def test_html_math_renderer_is_duplicated2(app, status, warning): + assert app.builder.math_renderer_name == 'imgmath' # The another one is chosen + + ++@pytest.mark.skip('Requires sphinxcontrib.jsmath module') + @pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinxcontrib.jsmath', + 'sphinx.ext.imgmath'], +@@ -1557,6 +1559,7 @@ def test_html_math_renderer_is_chosen(app, status, warning): + assert app.builder.math_renderer_name == 'imgmath' + + ++@pytest.mark.skip('Requires sphinxcontrib.jsmath module') + @pytest.mark.sphinx('html', testroot='basic', + confoverrides={'extensions': ['sphinxcontrib.jsmath', + 'sphinx.ext.mathjax'], diff --git a/debian/patches/skip_tests_network.diff b/debian/patches/skip_tests_network.diff new file mode 100644 index 0000000..f873091 --- /dev/null +++ b/debian/patches/skip_tests_network.diff @@ -0,0 +1,63 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Tue, 20 Dec 2016 16:37:32 +0300 +Subject: Skip tests that require network access + +Forwarded: not-needed +--- + tests/test_build_latex.py | 1 + + tests/test_build_linkcheck.py | 3 +++ + tests/test_setup_command.py | 1 + + 3 files changed, 5 insertions(+) + +diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py +index 004fc02..374e5ee 100644 +--- a/tests/test_build_latex.py ++++ b/tests/test_build_latex.py +@@ -1384,6 +1384,7 @@ def test_latex_raw_directive(app, status, warning): + assert 'LaTeX: abc def ghi' in result + + ++@pytest.mark.skip('Requires internet access') + @pytest.mark.sphinx('latex', testroot='images') + def test_latex_images(app, status, warning): + app.builder.build_all() +diff --git a/tests/test_build_linkcheck.py b/tests/test_build_linkcheck.py +index 631c7fa..5df6b87 100644 +--- a/tests/test_build_linkcheck.py ++++ b/tests/test_build_linkcheck.py +@@ -23,6 +23,7 @@ from .utils import CERT_FILE, http_server, https_server + ts_re = re.compile(r".*\[(?P<ts>.*)\].*") + + ++@pytest.mark.skip('Requires internet access') + @pytest.mark.sphinx('linkcheck', testroot='linkcheck', freshenv=True) + def test_defaults(app): + app.build() +@@ -44,6 +45,7 @@ def test_defaults(app): + assert len(content.splitlines()) == 7 + + ++@pytest.mark.skip('Requires internet access') + @pytest.mark.sphinx('linkcheck', testroot='linkcheck', freshenv=True) + def test_defaults_json(app): + app.build() +@@ -105,6 +107,7 @@ def test_defaults_json(app): + } + + ++@pytest.mark.skip('Requires internet access') + @pytest.mark.sphinx( + 'linkcheck', testroot='linkcheck', freshenv=True, + confoverrides={'linkcheck_anchors_ignore': ["^!", "^top$"], +diff --git a/tests/test_setup_command.py b/tests/test_setup_command.py +index ef36467..6b36ac9 100644 +--- a/tests/test_setup_command.py ++++ b/tests/test_setup_command.py +@@ -99,6 +99,7 @@ def test_build_sphinx_with_nonascii_path(setup_command): + assert proc.returncode == 0 + + ++@pytest.mark.skip('Requires internet access') + @pytest.mark.setup_command('-b', 'linkcheck') + def test_build_sphinx_return_nonzero_status(setup_command): + srcdir = (setup_command.pkgroot / 'doc') diff --git a/debian/patches/skip_tests_serializinghtml.diff b/debian/patches/skip_tests_serializinghtml.diff new file mode 100644 index 0000000..659a071 --- /dev/null +++ b/debian/patches/skip_tests_serializinghtml.diff @@ -0,0 +1,28 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Thu, 6 Feb 2020 23:55:28 +0300 +Subject: Skip tests that require sphinxcontrib.serializinghtml module + +--- + tests/test_api_translator.py | 2 ++ + 1 file changed, 2 insertions(+) + +diff --git a/tests/test_api_translator.py b/tests/test_api_translator.py +index 25aee0c..033d5d4 100644 +--- a/tests/test_api_translator.py ++++ b/tests/test_api_translator.py +@@ -40,6 +40,7 @@ def test_singlehtml_set_translator_for_singlehtml(app, status, warning): + assert translator_class.__name__ == 'ConfSingleHTMLTranslator' + + ++@pytest.mark.skip('Requires sphinxcontrib.serializinghtml module') + @pytest.mark.sphinx('pickle', testroot='api-set-translator') + def test_pickle_set_translator_for_pickle(app, status, warning): + translator_class = app.builder.get_translator_class() +@@ -47,6 +48,7 @@ def test_pickle_set_translator_for_pickle(app, status, warning): + assert translator_class.__name__ == 'ConfPickleTranslator' + + ++@pytest.mark.skip('Requires sphinxcontrib.serializinghtml module') + @pytest.mark.sphinx('json', testroot='api-set-translator') + def test_json_set_translator_for_json(app, status, warning): + translator_class = app.builder.get_translator_class() diff --git a/debian/patches/support_old_search_indexes.diff b/debian/patches/support_old_search_indexes.diff new file mode 100644 index 0000000..ed8bd18 --- /dev/null +++ b/debian/patches/support_old_search_indexes.diff @@ -0,0 +1,35 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Sat, 11 Dec 2021 19:19:27 +0300 +Subject: Make searchtools.js support old searchindex.js files + +Sphinx 4.3 has changed format of searchindex.js files, but in Debian +there are lots of packages built with older Sphinx, and we want to +keep them working for some time. + +Forwarded: not-needed +--- + sphinx/themes/basic/static/searchtools.js | 9 ++++++--- + 1 file changed, 6 insertions(+), 3 deletions(-) + +diff --git a/sphinx/themes/basic/static/searchtools.js b/sphinx/themes/basic/static/searchtools.js +index e89e34d..8279279 100644 +--- a/sphinx/themes/basic/static/searchtools.js ++++ b/sphinx/themes/basic/static/searchtools.js +@@ -426,11 +426,14 @@ const Search = { + filenames[match[0]], + ]); + }; +- Object.keys(objects).forEach((prefix) => ++ Object.keys(objects).forEach((prefix) => { ++ if (!(objects[prefix] instanceof Array)) { ++ objects[prefix] = Object.entries(objects[prefix]).map(([name, match]) => [...match, name]); ++ } + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) +- ) +- ); ++ ); ++ }); + return results; + }, + diff --git a/debian/patches/use_packaged_mathjax.diff b/debian/patches/use_packaged_mathjax.diff new file mode 100644 index 0000000..f28f920 --- /dev/null +++ b/debian/patches/use_packaged_mathjax.diff @@ -0,0 +1,20 @@ +From: Dmitry Shachnev <mitya57@debian.org> +Date: Tue, 4 Feb 2020 00:12:18 +0300 +Subject: Use packaged MathJax (for our own documentation) + +--- + doc/conf.py | 1 + + 1 file changed, 1 insertion(+) + +diff --git a/doc/conf.py b/doc/conf.py +index ec845be..d24ef11 100644 +--- a/doc/conf.py ++++ b/doc/conf.py +@@ -127,6 +127,7 @@ intersphinx_mapping = { + locale_dirs = ['locale/'] + gettext_compact = False + ++mathjax_path = 'file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML' + + # -- Extension interface ------------------------------------------------------- + diff --git a/debian/python3-sphinx.install b/debian/python3-sphinx.install new file mode 100644 index 0000000..fbf38fe --- /dev/null +++ b/debian/python3-sphinx.install @@ -0,0 +1,2 @@ +/usr/bin +/usr/lib/python3.*/dist-packages/ diff --git a/debian/python3-sphinx.links b/debian/python3-sphinx.links new file mode 100644 index 0000000..13b1376 --- /dev/null +++ b/debian/python3-sphinx.links @@ -0,0 +1,4 @@ +usr/bin/sphinx-apidoc usr/share/sphinx/scripts/python3/sphinx-apidoc +usr/bin/sphinx-autogen usr/share/sphinx/scripts/python3/sphinx-autogen +usr/bin/sphinx-build usr/share/sphinx/scripts/python3/sphinx-build +usr/bin/sphinx-quickstart usr/share/sphinx/scripts/python3/sphinx-quickstart diff --git a/debian/python3-sphinx.preinst b/debian/python3-sphinx.preinst new file mode 100644 index 0000000..b4b7bd6 --- /dev/null +++ b/debian/python3-sphinx.preinst @@ -0,0 +1,13 @@ +#!/bin/sh + +set -e + +if [ "$1" = upgrade ] && dpkg --compare-versions "$2" lt 2.4.3-3~ +then + for exe in /usr/share/sphinx/scripts/python3/* + do + update-alternatives --remove ${exe##*/} $exe + done +fi + +#DEBHELPER# diff --git a/debian/python3-sphinx.pyremove b/debian/python3-sphinx.pyremove new file mode 100644 index 0000000..cf9e72b --- /dev/null +++ b/debian/python3-sphinx.pyremove @@ -0,0 +1 @@ +sphinx/locale/.tx/ diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..0e5cf5f --- /dev/null +++ b/debian/rules @@ -0,0 +1,84 @@ +#!/usr/bin/make -f +# -*- makefile -*- + +export NO_PKG_MANGLE=1 +export LC_ALL=C.UTF-8 +export PYTHONWARNINGS=d + +export PYBUILD_TEST_ARGS=--verbose --ignore tests/test_api_translator.py + +locales = $(notdir $(patsubst %/LC_MESSAGES,%,$(wildcard sphinx/locale/*/LC_MESSAGES))) + +debroot = debian/tmp/ +py3_libdir = /usr/lib/$(shell py3versions -d)/dist-packages +py3_builddir = $(shell pybuild --print build_dir --interpreter python3) +javascript_path = /usr/share/javascript/sphinxdoc/1.0/ + +%: + dh $@ --with python3 --buildsystem=pybuild + +override_dh_auto_build: + ln -sf /usr/share/javascript/jquery/jquery.js sphinx/themes/basic/static/jquery.js + ln -sf /usr/share/javascript/underscore/underscore.js sphinx/themes/basic/static/underscore.js + dh_auto_build +ifeq "$(filter nodoc,$(DEB_BUILD_OPTIONS))" "" + PYTHONPATH=$(py3_builddir) python3 ./sphinx/cmd/build.py -T doc build/html/ + find build/html/ -name '*.txt' -or -name '*.html' | xargs -L1 sed -i \ + 's!http://docutils.sourceforge.net/docs/!file:///usr/share/doc/docutils-doc/docs/!g' + PYTHONPATH=$(py3_builddir) python3 ./sphinx/cmd/build.py -T -b man doc build/man +endif + PYTHONPATH=$(py3_builddir) python3 ./utils/babel_runner.py compile + +override_dh_auto_install: + pybuild --install -p $(shell py3versions -vd) + # move static files outside dist-packages + sed -i -e "s!^package_dir = .*!package_dir = '/usr/share/sphinx'!" \ + $(debroot)$(py3_libdir)/sphinx/__init__.py + mkdir -p $(debroot)/usr/share/sphinx + cd $(debroot) && mv -t usr/share/sphinx/ \ + .$(py3_libdir)/sphinx/templates \ + .$(py3_libdir)/sphinx/texinputs \ + .$(py3_libdir)/sphinx/themes + mkdir -p $(debroot)/usr/share/sphinx/ext/autosummary/ + cd $(debroot) && mv -t usr/share/sphinx/ext/autosummary/ \ + .$(py3_libdir)/sphinx/ext/autosummary/templates + mkdir -p $(debroot)/usr/share/sphinx/search/ + cd $(debroot) && mv -t usr/share/sphinx/search/ \ + .$(py3_libdir)/sphinx/search/minified-js \ + .$(py3_libdir)/sphinx/search/non-minified-js + set -e -x; \ + cd $(debroot) && \ + for lang in $(locales); \ + do \ + install -m 644 -D $(CURDIR)/sphinx/locale/$$lang/LC_MESSAGES/sphinx.js \ + usr/share/sphinx/locale/$$lang/sphinx.js; \ + install -m 644 -D $(CURDIR)/sphinx/locale/$$lang/LC_MESSAGES/sphinx.mo \ + usr/share/locale/$$lang/LC_MESSAGES/sphinx.mo; \ + done + cd $(debroot)$(py3_libdir)/sphinx/locale && rm -rf sphinx.pot */ + # Move JavaScript code to libjs-sphinxdoc: + PYTHONPATH=$(py3_builddir) debian/dh-sphinxdoc/install-js debian/libjs-sphinxdoc$(javascript_path) + rm -f $(debroot)/usr/share/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js + set -e; \ + for js in $$(find $(debroot)/usr/share/sphinx/themes/ -name '*.js' -a '!' -name 'websupport.js'); do \ + mv $$js debian/libjs-sphinxdoc/$(javascript_path); \ + ln -sf "$(javascript_path)/$${js##*/}" $$js; \ + done + +override_dh_installchangelogs: + dh_installchangelogs CHANGES + +override_dh_installdocs: + dh_installdocs +ifeq "$(filter nodoc,$(DEB_BUILD_OPTIONS))" "" + ./debian/dh-sphinxdoc/dh_sphinxdoc -p sphinx-doc /usr/share/doc/sphinx-doc/html/ +endif + +override_dh_installman: + cd debian/dh-sphinxdoc/ && pod2man -c Debhelper -r '' dh_sphinxdoc dh_sphinxdoc.1 +ifeq "$(filter nodoc,$(DEB_BUILD_OPTIONS))" "" + dh_installman +endif + +override_dh_compress: + dh_compress -X.py -X.rst -X.json -X.txt diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..163aaf8 --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/debian/source/lintian-overrides b/debian/source/lintian-overrides new file mode 100644 index 0000000..012ea9f --- /dev/null +++ b/debian/source/lintian-overrides @@ -0,0 +1,10 @@ +# Generated from the .po files using ‘setup.py compile_catalog’ +sphinx source: source-is-missing [sphinx/locale/*/LC_MESSAGES/sphinx.js] + +# Non-minified versions are available in separate files +sphinx source: source-is-missing [sphinx/themes/basic/static/underscore.js] +sphinx source: source-is-missing [sphinx/themes/basic/static/jquery.js] +sphinx source: source-is-missing [sphinx/themes/bizstyle/static/css3-mediaqueries.js] + +# Non-minified versions are available in sphinx/search/non-minified-js/* +sphinx source: source-is-missing [sphinx/search/minified-js/*] diff --git a/debian/source/options b/debian/source/options new file mode 100644 index 0000000..b5dbec1 --- /dev/null +++ b/debian/source/options @@ -0,0 +1,2 @@ +extend-diff-ignore = "^[^/]*[.]egg-info/" +extend-diff-ignore = "^sphinx/locale/[^/]+/LC_MESSAGES/" diff --git a/debian/sphinx-common.install b/debian/sphinx-common.install new file mode 100644 index 0000000..a52bbe6 --- /dev/null +++ b/debian/sphinx-common.install @@ -0,0 +1,9 @@ +/usr/share/locale/ +/usr/share/sphinx/ext/ +/usr/share/sphinx/locale/ +/usr/share/sphinx/search/ +/usr/share/sphinx/templates/ +/usr/share/sphinx/texinputs/ +/usr/share/sphinx/themes/ +debian/dh-sphinxdoc/dh_sphinxdoc /usr/bin/ +debian/dh-sphinxdoc/sphinxdoc.pm /usr/share/perl5/Debian/Debhelper/Sequence/ diff --git a/debian/sphinx-common.lintian-overrides b/debian/sphinx-common.lintian-overrides new file mode 100644 index 0000000..56becc8 --- /dev/null +++ b/debian/sphinx-common.lintian-overrides @@ -0,0 +1,3 @@ +# sphinx-common postinst must not be run if old version on python-sphinx is +# even unpacked. +sphinx-common: conflicts-with-version python-sphinx (<< 1.1) diff --git a/debian/sphinx-common.manpages b/debian/sphinx-common.manpages new file mode 100644 index 0000000..c0ddd4b --- /dev/null +++ b/debian/sphinx-common.manpages @@ -0,0 +1,5 @@ +build/man/sphinx-apidoc.1 +build/man/sphinx-autogen.1 +build/man/sphinx-build.1 +build/man/sphinx-quickstart.1 +debian/dh-sphinxdoc/dh_sphinxdoc.1 diff --git a/debian/sphinx-doc.doc-base b/debian/sphinx-doc.doc-base new file mode 100644 index 0000000..8af0b37 --- /dev/null +++ b/debian/sphinx-doc.doc-base @@ -0,0 +1,12 @@ +Document: sphinx-manual +Title: Sphinx documentation builder manual +Author: Georg Brandl +Abstract: Sphinx is a tool that translates a set of reStructuredText source + files into various output formats, automatically producing cross-references, + indices etc. It can also generate a LaTeX file that you can compile into a PDF + version of the documents. +Section: Text + +Format: HTML +Index: /usr/share/doc/sphinx-doc/html/index.html +Files: /usr/share/doc/sphinx-doc/html/* diff --git a/debian/sphinx-doc.docs b/debian/sphinx-doc.docs new file mode 100644 index 0000000..79c4f46 --- /dev/null +++ b/debian/sphinx-doc.docs @@ -0,0 +1,3 @@ +AUTHORS +README.rst +build/html diff --git a/debian/sphinx-doc.links b/debian/sphinx-doc.links new file mode 100644 index 0000000..afafcca --- /dev/null +++ b/debian/sphinx-doc.links @@ -0,0 +1,3 @@ +/usr/share/doc/sphinx-doc/html/ /usr/share/doc/python3-sphinx/html +/usr/share/doc/sphinx-doc/html/_sources/ /usr/share/doc/sphinx-doc/rst +/usr/share/doc/sphinx-doc/rst/ /usr/share/doc/python3-sphinx/rst diff --git a/debian/sphinx-doc.lintian-overrides b/debian/sphinx-doc.lintian-overrides new file mode 100644 index 0000000..ea525bc --- /dev/null +++ b/debian/sphinx-doc.lintian-overrides @@ -0,0 +1,4 @@ +# As per policy 6.6, dpkg cannot replace a directory (shipped in +# python-sphinx << 1.1) with a symlink to directory (shipped in +# sphinx-doc). +sphinx-doc: conflicts-with-version python-sphinx (<< 1.1) diff --git a/debian/tests/control b/debian/tests/control new file mode 100644 index 0000000..9216e3b --- /dev/null +++ b/debian/tests/control @@ -0,0 +1,25 @@ +Tests: python3-sphinx +Depends: dvipng, + fonts-freefont-otf, + graphviz, + imagemagick-6.q16, + librsvg2-bin, + python3-all, + python3-html5lib, + python3-pytest, + python3-setuptools, + python3-sphinx, + python3-sphinxcontrib.websupport, + python3-sqlalchemy (>= 0.9), + python3-whoosh, + python3-xapian, + tex-gyre, + texinfo, + texlive-fonts-recommended, + texlive-latex-extra, + texlive-luatex, + texlive-xetex + +Tests: sphinx-doc +Depends: gir1.2-webkit-6.0, python3-gi, sphinx-doc, xauth, xvfb +Restrictions: allow-stderr, isolation-machine diff --git a/debian/tests/python3-sphinx b/debian/tests/python3-sphinx new file mode 100755 index 0000000..581df90 --- /dev/null +++ b/debian/tests/python3-sphinx @@ -0,0 +1,10 @@ +#!/bin/sh +set -e -u +cp -r tests "$AUTOPKGTEST_TMP/" +cd "$AUTOPKGTEST_TMP" +py3versions -s \ +| tr ' ' '\n' \ +| xargs -I {} env PYTHONWARNINGS=d PYTHONHASHSEED=random {} \ + -m pytest -vv 2>&1 + +# vim:ts=4 sw=4 et diff --git a/debian/tests/sphinx-doc b/debian/tests/sphinx-doc new file mode 100644 index 0000000..e017fd9 --- /dev/null +++ b/debian/tests/sphinx-doc @@ -0,0 +1,20 @@ +#!/bin/sh +set -e -u + +export GTK_A11Y=none + +cp -r debian/jstest "$AUTOPKGTEST_TMP/" +cd "$AUTOPKGTEST_TMP" +for format in rst html +do + [ "$(readlink -f /usr/share/doc/python3-sphinx/$format)" = "$(readlink -f /usr/share/doc/sphinx-doc/$format)" ] +done +run_js_tests='jstest/run-tests /usr/share/doc/sphinx-doc/html/' +if [ -n "${DISPLAY:-}" ] +then + $run_js_tests +else + xvfb-run -a $run_js_tests +fi + +# vim:ts=4 sw=4 et diff --git a/debian/upstream/metadata b/debian/upstream/metadata new file mode 100644 index 0000000..ded997a --- /dev/null +++ b/debian/upstream/metadata @@ -0,0 +1,5 @@ +Bug-Database: https://github.com/sphinx-doc/sphinx/issues +Bug-Submit: https://github.com/sphinx-doc/sphinx/issues/new +Documentation: https://www.sphinx-doc.org/en/master/ +Repository: https://github.com/sphinx-doc/sphinx.git +Repository-Browse: https://github.com/sphinx-doc/sphinx diff --git a/debian/upstream/signing-key.asc b/debian/upstream/signing-key.asc new file mode 100644 index 0000000..d66c94f --- /dev/null +++ b/debian/upstream/signing-key.asc @@ -0,0 +1,124 @@ +-----BEGIN PGP PUBLIC KEY BLOCK----- + +mQENBFQEg/ABCADtNZwRrgEE7ulUnKKIP1Y1AyZZtxwOLcCc6Hk4CYQdwURWYwKm +bHUtyBrOd6xvclr1APM/xvfHa+VN1vnVRiMFxocBGid8OYg3EqmvPat3Dh830fUE +CStNZcm4uNtJWboDp93bPK9ZZf7sJZ0DgKEzy+TQU61nZwjn7L17PVM6mNDBl95O +PFVZ94A9dIkwYDX90NlK0AkF0EOzOkjcxlXIwu43EyYRiuzEgOFYjXvSZPNhVzge +kbziVqtmUyD1znbE4lNeFJutT3++3Wi8WWrWZsM7VyoMUjHVN0cSGOyiK3Mkf78i +frOnBNS9WMEaMGq/Q6Exnn2kAMpi/kQZp47BABEBAAG0LFRha2F5dWtpIFNoaW1p +enVrYXdhIDxzaGltaXp1a2F3YUBnbWFpbC5jb20+iQE4BBMBAgAiBQJUBIPwAhsD +BgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRAUJfjOXroOB3EtCADMXCZfIdY1 +tmEB+otb+CGKHqTlHjgZWJAif6YSyHmhkR8+AY2Baq/K0MavwSwOGP3m2Dur9JSL +yKKkUcpTuQ6lCF5pSfmbzOaByTyaPRQSlCBXgSXiEGXhC8cTCPR0XnIisBvzDnOW +iBwZhKRFKMhtiFzb2gX5rDxy35hWki7eLK2hR+e/8o3xnc0FwyUaJURViEL0vdVc +LuA7f/CyWfJIVJVMSTqUfUTGioy1WAyRG76gnCfzCHjeCU2g0hcEGRLX90OsLp5+ +cTCM3flITisg5naBBXzvGPaVJabWirm28xtmVF0oZ+v9t4KAMKhQejQMZjOyTKJH +I2meZXspt+yJuQENBFQEg/ABCADm06rOdh2XQCFHDvVJqDwBRVMGt1yze/OFI5E2 +TIXkbgd0rsjvP+WJly5Gs/keqvj/OSvl8WF+HfySzOLU05MimgJTznV5dltMWl2A +iuz/qf62vpmUuAO3mjB5POvU+9vvPcqFzPobkqisrYJoJpK8frhIegrdGnglGkVj +0V46yMkWN36S1LZslH4BRqBJiu6l0kiyHusqBvMEwPJDzc25A8QHGDIN9rxEKJXB +tianT2xbFfFCRJRGf+yiWUvZazMk9sgpKYq8gcUL6M5rx7rT/KdLEnhNSw0rbwRU +wt85Iu+L2t4Nu1gB/ouNTYctTqb4btyUUdq4tCZLPlTZqkCdABEBAAGJAR8EGAEC +AAkFAlQEg/ACGwwACgkQFCX4zl66DgcAUwf/az/FTRZ6vRR0BDAPfKMpAHxU/WnL +sM39OVwys2vVFv15vovb5hgYlqriEX5URrbYp6jV5tn/nNIJwK9EWHhagv3DhLAl +AASZCCbtBek+XZuSLb8pKcIIcVDeaGqgBdjTYYIbQvTE/K4Gh7uiz91NF1xTwedd +GlV6m3ncGiiT/qC33ATw5J6WkUBVlW9e+QSCVbLs+Jihx6MJAZt346xOomAbLM0n +tFbmQqgY4Q7g7Z11kkOL1uAyeuDiUhgWnV3ua4yN29wEVG5gzSRG00HcPm23D/CJ +6l2RlWdtcLlTuTYO071MrrD8G0XWxJ3cuZZIfFryhhenMz0HzQSK0/qOKJkCDQRX +Sn0iARAAqnrti1Y8jgrEwQvAIOT9I3aLBQkAwX+HSiUhOGnZgIlJ5aTFnTnAHN94 +J7TqbjIgHldMc2abNuqQoFZu1m8JmFi5IddOpdvPDwz1EZ1W2DEGAol1iBs9wxFM +JwotfAxS2aPbQpiUgHvAfgC0vkSK2DkDAqnicU2BZJ4gWpUF3sKjojx6BSB9zB7v +iUqFdg+66aJo5j6li2QlalCYqHHAK020NozO3KY2F3HsHWE9pW+V3dEd4jSwwhkP +1EssX4/POzeDqVJ7A2a46jNVxMiQSeSKyb1Vs4w9x2ZZnuxpOxRO+PBlFzFjgUWU +msy0H/G59Pe5Wyzwjt3UR/BWZYieYmhHYfgxL3djwBie+ZxPvH5LoSS+otZRnfAI +IhGvW8q2i0mKxnykNyAEWvXyvNXoP64atgoiTTG+ivl9tdgCmvMLFHL20aNKwl3v +7dl+bpVQBlCSlHVavCjhnA/lLxRE5JhpK5nNJ5FXzERFZN+OE3I1q4J+t2f+bBXE +jaKD3FIn1r+oIxYrnaxmOC1hZUdX52nCbPLChAc4kNOU1v/wnAVAHU46LvaOQknv +AjND29vRrZcL981OTz40fWQc5t7KqhdwgbRFim+0ZwFiItnj6JDmvZin5HMkeL7k +q9VV5rK16eFoleIZ1c5B7GhSCRF/Aqp1yNjg20R+tVIYc4X76REAEQEAAbQkVGFr +ZXNoaSBLT01JWUEgPGkudGtvbWl5YUBnbWFpbC5jb20+iQJVBBMBCAA/AhsDBgsJ +CAcDAgYVCAIJCgsEFgIDAQIeAQIXgBYhBIoRt5pdDXSaZvCgMBAsLBdJjWueBQJg +4fZTBQkPOxOxAAoJEBAsLBdJjWueaKUP/2P7PNksowNnkGZeFRCevd8Hp9z0n8rF +Gwbm/THwRUEQ07MW+vVdmnwcC9TTgQGeCQT18wsBTT1Rc5GQ+KdWH/6pigno0yh1 +cCgEOmQUxp8gyJO8Z+BVDffnh8A1NekRXMcywJhRFgFXxZjlB/9bd9pxs+xJRZ7r +zRhvG/fMHccmRbeauOj58MIqWVPOryz0nNJ2ruyK0nOc0r3KAFPxs1VggUX3VFkZ +Qbl0JPg/SIT0VcMq4TaUtx/ufJZ0xaz35e1HDL5VxAl+LC8/UwotLw0CxkKNuM0H +5jTTC7SRm2R3FBwcS4QUGbUMUOhqQ/oCHE1t/p3hn4TH8xBow9ahh5MxQ2zApoxo +NBxMmC+9rwe8o2Q27nLET5HL4jThucXzWFzMp8vaxu3P2zIUFILziCEfh71/O3PP +BcKakm0uWXNFa/qhR3YDrx+EPV3xvrvfVS/HG/aYYHFaVLIy/pBGOydnp5bD8CHI +GqgM/OT0HAMc1ZkKDDulIDC6qqvwRaaI8//cfgxuwaW5vDFfmMn+G2jbV8KBbtL+ +gbDxpoP+/2L/kaYZi9Mp0CL8TMyDZEjkOWAXjHqUM0FbB9G5HZhflcCNgYdWOAse +JEHWav/JZ9/oR8YtSG1cqWurh4iBIqI/LEh+bxZ7M7yBQxhryxCSc6pNMO9lVPQq +NqPImvNzvOk6uQINBFdKfSIBEADDALaWazTrShzNX/tTol0UQ3L0uarqppT49TId +XYjUsjc7/hv+tu+4z9euQOhhlFX5KNhnGOZ5S8VAGABZQH+3e6RvfIxuIvrHzOBt +Zr+sY+nHF5NIIfyF0zZCbYETyOMbcsB/CB3fZssGueZvLslxUwkMAwgM2+1ZCOP2 +FM0940KgEHMnjDRffUoONrVRmM6IrOZw1UJX6JgUadO1MKDfqNMMfIeM2CZQSd6W +v6ciiT3OsNE1oHTnj7ZehIFyIXXPdC92Ul1utNlQnkL1D02yB90eMPshW/sRN0n+ +88zXCCHfRt4r3jvgW4nR+RzAzwfbiT0AzhIZsSJ9rjXJtgFrRu7eIiVJmsBDpSHL +TR93zO8GLEMvImWZSp3NkXOgvTfk5pwJrjER3XX5A5WTt2qTEwclT8s/CAmk4IVi +e5Tijdic6G4qR7fOfTpPzBRZBMdcb+JVqPqZ1tZo8Dh9vzgjafnS5Uxi2exI+dci +7HOCQwplzIb4paaVo6m7YabxZZOCUiyEh0bgZRTASaD1gksjrGgE3N7ilt/Soijf +hWDToSsBtgPG4FE/3vuXPMgc64ZGKR091o+OIpNxu/QE7oGYL+erAPrTEvA1Y5VG +AkmWhaBxFSzM6AfQ7PURo79QpqqJeMQW7sAlwxueOoK/b3xQPrH61SuB1PA2LIqT +tJ1OWQARAQABiQI8BBgBCAAmAhsMFiEEihG3ml0NdJpm8KAwECwsF0mNa54FAmDh +9mgFCQ87E8YACgkQECwsF0mNa55nPg/+JfsakZS5YVaD7tD24/RMB4mOzeku0Ubx +LPdXZlWkI2r76okBaiI4Chsuh5+24xtlxBraOndEkKHlbcsUKudMoxIF+z++PvVs +pGQI41mIY4mbof/F/41u6ybS1lhyES8A0vw/3a5ZVj28ZC8ETFPIIP7WGs1zIDwq +bZL4+9a6KtxkygdpguOgMz7BBNSzLl/JDwZFa3PYpQgJpem86G1aKupVP4GAAL0V ++Kc2mP5I5ci3rIzbf9NyGdnuuMLTBTzweqlbeEpT/TlVBVC5DTXci/M2EcD1G6rm +EoHgBFCjdl/97QtH7pV7+D/5t14y9C3oGa5I2+Jg46gO0KaGVtIuJ1WCjd4Cr2y2 +LZV3fVfkT7aUeJF1zgIycvHwB1vnaJL0zFZXegfmGKrYrgwVYDJSVPs3r+8mV3Wv +IVE+d30DuzCU4po/lKFylmRSnWeVQKIBuAWrSw3Ozqrd5S0W9exQiiNsf0sx5Qfy +6d9awoxvX/w5ANDEykE0j0dHF02G2dMM5l5VteeWkGyabKXe8uQ3zV2uXG3PJmq9 +1DK8WCoNKQiDp/w1FexkED6GQKMiQwZZpB+oQlldUyxx6pcIpb+qicPRvzxRcLOf +cLICI5hvIE91xhuy5BvyUEdQO5yU3PfXmKH2KvUiU584Gwn1CaPXWpWgGPZE9cC6 +igVYN9m4taaZAg0EYtSBQgEQAMIIHp74K11+4RtfBQ5TXs5qWyq77jKVUC5/m0KL +gCcr0O3L/iBMQoyVmo5Bd+tmfSkol7ESThH0nkXHb/4BfTgegkvStp/xUPYN3b5F +ItzrnIPg0DfamcHXKhT+QOj5o8QhfItbmqpy7gGvmSPoCCOrK+w01GE5Bj/unBUx +nr4CPcu2z5aVMxzIUDY5UueN33VsUnBklgy3a0u2UfkeW6y5hfgxxDwp5+QWU8Rk +hg99nBWm2nFJY8ylOCMQAcTvRbyZqz2PCwZOSJlehegYEdrbx73nLDgA6rCEv4Jz +ret4yQkkWmwuXXmOWwsSyaDcI5UNEHbKTe6FKBWvMDfvzWNXL9M1M0roGRJeNzSy +SJLDlgxmC5+jUP80No0MaYwHXj8Gqdnuzlsf1DDZmEQ53R0kQbJmiz+eMhypZ0J0 +iyMQU9wdr6CF41BMAhZYzQpPvw4rQcms2YqA/68NNxiCWtwPJ6ZhhgX8omymIuRM +Ro7PNTn2DosVb9ckFjbDGeNrigtLvgxr6zSbIu4wIjzzueaCVHCQ2WCIkIn9V4Wv +llagVPDTMRU4diWFk1tX1KztbeX1yQLlVE6F50qypOIBc3LEfDm98ntoKxz8EdtU +qOJAvD43WYD94/EYNPJSkORAWlWqNlwPFr2B0Hezb998STrIJ+nQbR2OOjrL48hc +CSORABEBAAG0OEFkYW0gVHVybmVyIDw5MDg3ODU0K2FhLXR1cm5lckB1c2Vycy5u +b3JlcGx5LmdpdGh1Yi5jb20+iQJRBBMBCAA7FiEE01SRGb1RtK/mQ+WXUsj3KmHw ++1IFAmLUgUICGyMFCwkIBwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQUsj3KmHw ++1KkKQ/8DtBCpII1oAPrluLXS6il9arXiIn3NTNQxA0wpSQtunDzJVzYW/bW2Y/A +OuGB+gqwh60eG+j6GDuOzvOxD7/Fj1cpDbRqv3/yHd1xv00N2caijTynyC0ONDvx +ijo5hq51stBEISyjhqw1wr0g78ByKQnRW1JIifiBdMSXlqZRRKzLYWQ0YeuKAq92 +1CNvgbLkyp0cPsJMMVW2o51Xrs1XCl4Cy86lfhX9tAb9qI+tmE7epjpvS8USAyXR +dpLTqkiiaKmavJykuJNbHBWbuCknJpYbGQ6amvn5YvPqFsUKRCbTP0NDx+tgxGrg +3YJceffp5d4+SPW7qHgMImmcj8lsmYhjVI7xHnMddnerQRTUGy9v42xqN8nv6lIE +Fi0+7tBoZ8O0GMbUP/gJxaNehA+nS8vaeLBdUcEmgJpv3caDweo/aW+p3zYfs5On +BZIl8RDU73WHqU/G9T6YPisRtGuncR33XRXwqu4XlbAVGDC6ozVNxRdmeKm9rSPR +i12LD/VXjtiS4+yHM8479qeY9eTusofRCWNLQdQkh4SrrrDjMq659ELns8wWI4j6 +NeNr4MPTdfwptCuz6+ME/KExYn69dzoRTL4hNG9fedULzTvl2cvx9E1KPnKfYFDT +wgPM0Ke+9oUNqzJpJh+bC5sxdz0AY3d+fDNlcoF/ZOw6qtPoYga5Ag0EYtSBQgEQ +ANFlb6OX2SZx3aILcWQx5irIl9VqSM8DsmoxxYdlpAEvQ0QTbV2cSMV62ck2Rj7s +fr/WlHNvgu2Ee37Av0ppkE5rRSzuMoeNUDt85fXts9B7GSmVny4Qjp1Xqb6LoQKL +2YA/HzcK0gOXktyRuBgM98FOjnwqZFBF5Q6KYt19pJQpJHzBh8Kn4zINeotW856r +7sbOn1K5ln06eUQ2JNrwx53yHqYxZmGkH4wmOWWz8ecRcKWUkvGquTi//NFa+Etg +0LQ7pk7cA1NOVf5vLneJhMw9g77N6iI9l5X8rV1MnlFFvdvq4XUvBSDoFoppCQHM +qI+JaTUPhUQwpQyML5KTjU5bGbuPtaP9O91VMPmUmsKBZYmQi4AeQCnOItfZhgW0 +xsmRV4+hnJs37GgS1dHHz+12VHHKdlF/zwGu1CbJQYnDC3hSMSBuai0vilN3YWRE +XoB1w3XUk2CmPM8gT6a8gVEIniWamWAObViJZnfS1PdvhH9+pN6EYjE5sb1UPoo9 +p/x5Bi7Lxp32IgwXFJeN0JlHCCQa0CYXFzwtObD1m7hhE2siXDrKp8BjL3vzX8w1 +cLatGY0pel9adXd2Y6A56epIrcDVESqdh6Rzx2thaxU9oXmKXgsIJ91rM6RwIrwq ++80ngkbK4gOirrtUWTJ3BsPpSoj1CuMll+x1rKoXBJMDABEBAAGJAjYEGAEIACAW +IQTTVJEZvVG0r+ZD5ZdSyPcqYfD7UgUCYtSBQgIbDAAKCRBSyPcqYfD7UrP9D/9+ +GlbFCufNJQiZP2ntsZDHVSMW/fusf2K/i+QDEM7lq/lAIOSve4YGkiWWsJz9bDGL +Ph+JUpavFuIBMAsDCYJXN+BSi5HJR8JCrLJEuryZZjfMZsbf3f/YDpUy76RnFgJJ +I1JKLp+LfeyixYa9CvdfKeuXWjLoi2/Fr7TcIa6Qb/u2naVCDdUSzMticpZZI6ds +GHqwUJpnZLsBn6rNd0XswPeAfv7OSZHwhzJ5SbU74/hFZxC1VQxt0c0k56v/wrNE +akVosxCUwEqBVALFtYTzDBOv5LgMhPgo8CPZMZyg8mhUztZbg8LDMfRrB+RS+7zk +xJc7zf8tQGNdzBajOyCZZur/FyJj94wa4itNUGGIT+G/vb0i88v57emlmqYG9WNo +cGCG/UsFrPEwCWWYHqmepV89PjemlveUcLXVtQMMmNM1SeQYG5jiUOxIPkBQPpq4 +YymZndC37NfTiqxXvlnmD5N0iTVuwf2ay/VKcBV/PwQlw4qoTFabE2I4wRyHrrYN +TM+b4KEdI+wkmYGpOfpkAPyAokFoHAqTpzr74IOmOFTWEOlJdC2JGpqz66U/Jx6/ +38Pt6eCjaef25gvp8mWEFHDQVVct7qlIT+gUCqg34XNLxG/PC3Xznc5CaX5o6Aq3 +YrNFKgLJlUoIyeTat2VRbUYSSsHPQ3JgIGsqi5ziPw== +=+WAQ +-----END PGP PUBLIC KEY BLOCK----- diff --git a/debian/watch b/debian/watch new file mode 100644 index 0000000..b84cad8 --- /dev/null +++ b/debian/watch @@ -0,0 +1,3 @@ +version=4 +opts=pgpsigurlmangle=s/$/.asc/ \ +https://pypi.debian.net/Sphinx/Sphinx-([\d.]+)\.tar\.gz |