[arch-commits] Commit in python-sphinx/trunk (2 files)
Johannes Löthberg
demize at archlinux.org
Sat May 15 10:55:55 UTC 2021
Date: Saturday, May 15, 2021 @ 10:55:55
Author: demize
Revision: 934631
Revert manpage generation change that breaks every project using sphinx to build manpages
Works around FS#70805.
Added:
python-sphinx/trunk/0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch
Modified:
python-sphinx/trunk/PKGBUILD
-----------------------------------------------------------------+
0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch | 130 ++++++++++
PKGBUILD | 12
2 files changed, 138 insertions(+), 4 deletions(-)
Added: 0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch
===================================================================
--- 0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch (rev 0)
+++ 0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch 2021-05-15 10:55:55 UTC (rev 934631)
@@ -0,0 +1,130 @@
+From 413d1008d96a44cba5bf82030f7e95450ae82554 Mon Sep 17 00:00:00 2001
+From: =?UTF-8?q?Johannes=20L=C3=B6thberg?= <johannes at kyriasis.com>
+Date: Sat, 15 May 2021 12:25:10 +0200
+Subject: [PATCH] Revert "Close #7996: manpage: Make a section directory on
+ build manpage by default"
+MIME-Version: 1.0
+Content-Type: text/plain; charset=UTF-8
+Content-Transfer-Encoding: 8bit
+
+This reverts commit a843fd3db8b588be93b576049a8a291bc4b3ec9d.
+
+Signed-off-by: Johannes Löthberg <johannes at kyriasis.com>
+---
+ CHANGES | 2 --
+ doc/usage/configuration.rst | 4 +---
+ sphinx/builders/manpage.py | 2 +-
+ tests/test_build_manpage.py | 12 ++++++------
+ tests/test_smartquotes.py | 4 ++--
+ 5 files changed, 10 insertions(+), 14 deletions(-)
+
+diff --git a/CHANGES b/CHANGES
+index b7e4c7f0e..7ca08a6ac 100644
+--- a/CHANGES
++++ b/CHANGES
+@@ -50,8 +50,6 @@ Incompatible changes
+ * #7784: i18n: The msgid for alt text of image is changed
+ * #5560: napoleon: :confval:`napoleon_use_param` also affect "other parameters"
+ section
+-* #7996: manpage: Make a section directory on build manpage by default (see
+- :confval:`man_make_section_directory`)
+ * #7849: html: Change the default setting of
+ :confval:`html_codeblock_linenos_style` to ``'inline'``
+ * #8380: html search: search results are wrapped with ``<p>`` instead of
+diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst
+index 7b7a0a1d4..3bc402c9a 100644
+--- a/doc/usage/configuration.rst
++++ b/doc/usage/configuration.rst
+@@ -2332,12 +2332,10 @@ These options influence manual page output.
+
+ .. confval:: man_make_section_directory
+
+- If true, make a section directory on build man page. Default is True.
++ If true, make a section directory on build man page. Default is False.
+
+ .. versionadded:: 3.3
+- .. versionchanged:: 4.0
+
+- The default is changed to ``False`` from ``True``.
+
+ .. _texinfo-options:
+
+diff --git a/sphinx/builders/manpage.py b/sphinx/builders/manpage.py
+index b993a2df4..532d2b8fe 100644
+--- a/sphinx/builders/manpage.py
++++ b/sphinx/builders/manpage.py
+@@ -118,7 +118,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
+
+ app.add_config_value('man_pages', default_man_pages, None)
+ app.add_config_value('man_show_urls', False, None)
+- app.add_config_value('man_make_section_directory', True, None)
++ app.add_config_value('man_make_section_directory', False, None)
+
+ return {
+ 'version': 'builtin',
+diff --git a/tests/test_build_manpage.py b/tests/test_build_manpage.py
+index 2affb8ba3..a017abc69 100644
+--- a/tests/test_build_manpage.py
++++ b/tests/test_build_manpage.py
+@@ -17,9 +17,9 @@ from sphinx.config import Config
+ @pytest.mark.sphinx('man')
+ def test_all(app, status, warning):
+ app.builder.build_all()
+- assert (app.outdir / '1' / 'sphinxtests.1').exists()
++ assert (app.outdir / 'sphinxtests.1').exists()
+
+- content = (app.outdir / '1' / 'sphinxtests.1').read_text()
++ content = (app.outdir / 'sphinxtests.1').read_text()
+ assert r'\fBprint \fP\fIi\fP\fB\en\fP' in content
+ assert r'\fBmanpage\en\fP' in content
+
+@@ -31,16 +31,16 @@ def test_all(app, status, warning):
+
+
+ @pytest.mark.sphinx('man', testroot='basic',
+- confoverrides={'man_make_section_directory': False})
++ confoverrides={'man_make_section_directory': True})
+ def test_man_make_section_directory(app, status, warning):
+ app.build()
+- assert (app.outdir / 'python.1').exists()
++ assert (app.outdir / '1' / 'python.1').exists()
+
+
+ @pytest.mark.sphinx('man', testroot='directive-code')
+ def test_captioned_code_block(app, status, warning):
+ app.builder.build_all()
+- content = (app.outdir / '1' / 'python.1').read_text()
++ content = (app.outdir / 'python.1').read_text()
+
+ assert ('.sp\n'
+ 'caption \\fItest\\fP rb\n'
+@@ -71,5 +71,5 @@ def test_default_man_pages():
+ @pytest.mark.sphinx('man', testroot='markup-rubric')
+ def test_rubric(app, status, warning):
+ app.build()
+- content = (app.outdir / '1' / 'python.1').read_text()
++ content = (app.outdir / 'python.1').read_text()
+ assert 'This is a rubric\n' in content
+diff --git a/tests/test_smartquotes.py b/tests/test_smartquotes.py
+index a8d4b1ed6..4879dedc6 100644
+--- a/tests/test_smartquotes.py
++++ b/tests/test_smartquotes.py
+@@ -31,7 +31,7 @@ def test_text_builder(app, status, warning):
+ def test_man_builder(app, status, warning):
+ app.build()
+
+- content = (app.outdir / '1' / 'python.1').read_text()
++ content = (app.outdir / 'python.1').read_text()
+ assert '\\-\\- "Sphinx" is a tool that makes it easy ...' in content
+
+
+@@ -84,5 +84,5 @@ def test_smartquotes_excludes_language(app, status, warning):
+ def test_smartquotes_excludes_builders(app, status, warning):
+ app.build()
+
+- content = (app.outdir / '1' / 'python.1').read_text()
++ content = (app.outdir / 'python.1').read_text()
+ assert '– “Sphinx” is a tool that makes it easy …' in content
+--
+2.31.1
+
Modified: PKGBUILD
===================================================================
--- PKGBUILD 2021-05-15 10:53:24 UTC (rev 934630)
+++ PKGBUILD 2021-05-15 10:55:55 UTC (rev 934631)
@@ -6,7 +6,7 @@
pkgname=python-sphinx
pkgver=4.0.1
-pkgrel=2
+pkgrel=3
pkgdesc='Python documentation generator'
arch=('any')
url=http://www.sphinx-doc.org/
@@ -29,13 +29,16 @@
optdepends=('imagemagick: for ext.imgconverter'
'texlive-latexextra: for generation of PDF documentation')
source=("https://pypi.org/packages/source/S/Sphinx/Sphinx-$pkgver.tar.gz"{,.asc}
- 'https://github.com/sphinx-doc/sphinx/commit/85f58874ecd9feb391e24f9d0197bef5cc637a87.patch')
+ 'https://github.com/sphinx-doc/sphinx/commit/85f58874ecd9feb391e24f9d0197bef5cc637a87.patch'
+ '0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch')
sha256sums=('cf5104777571b2b7f06fa88ee08fade24563f4a0594cf4bd17d31c47b8740b4c'
'SKIP'
- '560978f9fe91b169af8acb84cedbd291e4837f658468648d6e6c891a5f1bac2e')
+ '560978f9fe91b169af8acb84cedbd291e4837f658468648d6e6c891a5f1bac2e'
+ 'SKIP')
b2sums=('25ddb31a6db4eb1b76054be7026c327b47e33ec3efaa3eec70e5aae747931723baafe4b7b944ec4405589294698995bf7f5988187927f64db00ba77f44dccedc'
'SKIP'
- 'f4e84995fcaa77359becece089c8809e3472a743493b0126891b651871fc2d3e8f1d80fa9be86c063a155962ab8455af65ab92da96fda970bf2218d933446fc7')
+ 'f4e84995fcaa77359becece089c8809e3472a743493b0126891b651871fc2d3e8f1d80fa9be86c063a155962ab8455af65ab92da96fda970bf2218d933446fc7'
+ 'SKIP')
validpgpkeys=('8A11B79A5D0D749A66F0A030102C2C17498D6B9E' # Takeshi KOMIYA <i.tkomiya at gmail.com>
'E9BEABB07E7B9CC3F56E62C91425F8CE5EBA0E07') # Takayuki Shimizukawa <shimizukawa at gmail.com>
@@ -42,6 +45,7 @@
prepare() {
cd Sphinx-$pkgver
patch -p1 <"$srcdir"/85f58874ecd9feb391e24f9d0197bef5cc637a87.patch
+ patch -p1 <"$srcdir"/0001-Revert-Close-7996-manpage-Make-a-section-directory-o.patch
}
build() {
More information about the arch-commits
mailing list