PR#1: switching the documentation theme to sphinx rtd - rpms/python-fields

rpms / python-fields

#1 switching the documentation theme to sphinx rtd

Closed 2 years ago by cottsay. Opened 2 years ago by chedi.

rpms/ chedi/python-fields rawhide into rawhide

switching the documentation theme to sphinx rtd

Chedi Toueiti • 2 years ago

38dbb22

0001_changing_documentation_theme.patch

file added

+15

		`@@ -0,0 +1,15 @@`
		`+ --- a/docs/conf.py 2022-05-27 15:56:20.764767540 +0100`
		`+ +++ b/docs/conf.py 2022-05-27 16:13:01.232970721 +0100`
		`+ @@ -25,9 +25,9 @@`
		`+ author = 'Ionel Cristian Mărieș'`
		`+ copyright = '{0}, {1}'.format(year, author)`
		`+ version = release = '5.0.0'`
		`+ -import sphinx_py3doc_enhanced_theme`
		`+ -html_theme = "sphinx_py3doc_enhanced_theme"`
		`+ -html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]`
		`+ +import sphinx_rtd_theme`
		`+ +html_theme = "sphinx_rtd_theme"`
		`+ +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]`
		`+ html_theme_options = {`
		`+ 'githuburl': 'https://github.com/ionelmc/python-fields/'`
		`+ }`

python-fields.spec

file modified

+6 -3

		`@@ -2,7 +2,7 @@`

		`Name: python-%{srcname}`
		`Version: 5.0.0`
		`- Release: 11%{?dist}`
		`+ Release: 12%{?dist}`
		`Summary: Container class boilerplate killer`

		`License: BSD`
		`@@ -11,7 +11,7 @@`

		`# Compatibility with python-sphinx >= 1.3, already applied upstream`
		`Patch0: %{name}-5.0.0-sphinx-1.3.patch`
		`-`
		`+ Patch1: 0001_changing_documentation_theme.patch`
		`BuildArch: noarch`

		`%description`
		`@@ -28,7 +28,7 @@`
		`%package doc`
		`Summary: Documentation for '%{name}'`
		`BuildRequires: python%{python3_pkgversion}-sphinx`
		`- BuildRequires: python%{python3_pkgversion}-sphinx-theme-py3doc-enhanced`
		`+ BuildRequires: python%{python3_pkgversion}-sphinx_rtd_theme`

		`%description doc`
		`HTML API documentation for the '%{srcname}' Python module.`
		`@@ -85,6 +85,9 @@`
		`%{python3_sitelib}/%{srcname}-%{version}-py%{python3_version}.egg-info/`

		`%changelog`
		`+ * Fri May 27 2022 Chedi Toueiti <chedi.toueiti@gmail.com> - 5.0.0-12`
		`+ - Switching the sphinx documentation theme`
		`+`
		`* Fri Jan 21 2022 Fedora Release Engineering <releng@fedoraproject.org> - 5.0.0-11`
		`- Rebuilt for https://fedoraproject.org/wiki/Fedora_36_Mass_Rebuild`

chedi commented 2 years ago

In light of the 2042824 bug

https://bugzilla.redhat.com/show_bug.cgi?id=2040824

and the dependence on the python-sphinx-theme-py3doc theme

https://bugzilla.redhat.com/show_bug.cgi?id=2040821

I humbly suggest that you switch the documentation theme as the maintainer of the sphinx_py3doc_enhanced_theme packager seems to be inactive and the upstream has not seen any commit since 2019.