Skip to content

Commit 45d0b24

Browse files
committed
Bump requirements
- Upgrade to latest version of Sphinx (and other dependencies), - Use "language = 'en'" in configuration since recent Sphinx versions do not accept "language = None" anymore, - Add now required "%s" in extlinks config, - Refer to setuptools explicitly in :std:doc: because Sphinx no longer implicitly uses intersphinx (by default) for this role. See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes The generated HTML can be compared using $ diff -u build-old/ build-new | colordiff | diff-highlight The only visible change is "Permalink to this headling" becoming "Link to this heading".
1 parent 588c8cd commit 45d0b24

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
sphinx==4.5.0
1+
sphinx==7.2.6
22
sphinx-autobuild==2021.3.14
3-
sphinx-inline-tabs==2021.4.11b9
3+
sphinx-inline-tabs==2023.4.21
44
python-docs-theme==2023.9
5-
sphinx-copybutton==0.5.0
5+
sphinx-copybutton==0.5.2
66
pypa-docs-theme @ git+https://github.com/pypa/pypa-docs-theme.git
77
sphinx-toolbox==3.5.0

source/conf.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
#
8989
# This is also used if you do content translation via gettext catalogs.
9090
# Usually you set "language" from the command line for these cases.
91-
language = None
91+
language = 'en'
9292

9393
locale_dirs = ['../locales']
9494

@@ -379,11 +379,11 @@
379379

380380
# -- Options for extlinks extension ---------------------------------------
381381
extlinks = {
382-
'issue': (f'{github_repo_issues_url}/%s', '#'), # noqa: WPS323
383-
'pr': (f'{github_repo_url}/pull/%s', 'PR #'), # noqa: WPS323
384-
'commit': (f'{github_repo_url}/commit/%s', ''), # noqa: WPS323
385-
'gh': (f'{github_url}/%s', 'GitHub: '), # noqa: WPS323
386-
'user': (f'{github_sponsors_url}/%s', '@'), # noqa: WPS323
382+
'issue': (f'{github_repo_issues_url}/%s', '#%s'), # noqa: WPS323
383+
'pr': (f'{github_repo_url}/pull/%s', 'PR #%s'), # noqa: WPS323
384+
'commit': (f'{github_repo_url}/commit/%s', '%s'), # noqa: WPS323
385+
'gh': (f'{github_url}/%s', 'GitHub: %s'), # noqa: WPS323
386+
'user': (f'{github_sponsors_url}/%s', '@%s'), # noqa: WPS323
387387
}
388388

389389
linkcheck_ignore = [

source/guides/distributing-packages-using-setuptools.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ development as a whole. For example, it does not provide guidance or tool
1515
recommendations for version control, documentation, or testing.
1616

1717
For more reference material, see :std:doc:`Building and Distributing
18-
Packages <userguide/index>` in the :ref:`setuptools` docs, but note
18+
Packages <setuptools:userguide/index>` in the :ref:`setuptools` docs, but note
1919
that some advisory content there may be outdated. In the event of
2020
conflicts, prefer the advice in the Python Packaging User Guide.
2121

@@ -717,7 +717,7 @@ Lastly, if you don't want to install any dependencies at all, you can run:
717717
718718
For more information, see the
719719
:doc:`Development Mode <setuptools:userguide/development_mode>` section
720-
of the :doc:`setuptools docs <setuptools>`.
720+
of the :ref:`setuptools` docs.
721721

722722
.. _`Packaging your project`:
723723

source/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Python's native packaging is mostly built for distributing reusable
167167
code, called libraries, between developers. You can piggyback
168168
**tools**, or basic applications for developers, on top of Python's
169169
library packaging, using technologies like
170-
:doc:`setuptools entry_points <userguide/entry_point>`.
170+
:doc:`setuptools entry_points <setuptools:userguide/entry_point>`.
171171

172172
Libraries are building blocks, not complete applications. For
173173
distributing applications, there's a whole new world of technologies

0 commit comments

Comments
 (0)