Skip to content

Commit a19c187

Browse files
committed
⇪ Bump Sphinx to v3.2.0
This change also includes all the fixes necessary for Sphinx 3 not to explode during the build in the strict mode. In particular, it now barks on the case-sensitive `:term:` targets that don't match.
1 parent 1ee61aa commit a19c187

6 files changed

Lines changed: 18 additions & 17 deletions

File tree

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
sphinx==2.1.2
1+
sphinx==3.2.0
22
sphinx-autobuild==0.7.1
33
git+https://github.com/python/python-docs-theme.git#egg=python-docs-theme
44
git+https://github.com/pypa/pypa-docs-theme.git#egg=pypa-docs-theme

source/glossary.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Glossary
2727
Distribution Package
2828

2929
A versioned archive file that contains Python :term:`packages <Import
30-
Package>`, :term:`modules <module>`, and other resource files that are
30+
Package>`, :term:`modules <Module>`, and other resource files that are
3131
used to distribute a :term:`Release`. The archive file is what an
3232
end-user will download from the internet and install.
3333

@@ -49,7 +49,7 @@ Glossary
4949

5050
Extension Module
5151

52-
A :term:`module` written in the low-level language of the Python implementation:
52+
A :term:`Module` written in the low-level language of the Python implementation:
5353
C/C++ for Python, Java for Jython. Typically contained in a single
5454
dynamically loadable pre-compiled file, e.g. a shared object (.so) file
5555
for Python extensions on Unix, a DLL (given the .pyd extension) for
@@ -121,7 +121,7 @@ Glossary
121121

122122
Pure Module
123123

124-
A :term:`module` written in Python and contained in a single ``.py`` file (and
124+
A :term:`Module` written in Python and contained in a single ``.py`` file (and
125125
possibly associated ``.pyc`` and/or ``.pyo`` files).
126126

127127

@@ -152,7 +152,7 @@ Glossary
152152

153153
pyproject.toml
154154

155-
The tool-agnostic :term:`project` specification file.
155+
The tool-agnostic :term:`Project` specification file.
156156
Defined in :pep:`518`.
157157

158158
Release

source/guides/installing-scientific-packages.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ environments. Allowing access to distributions installed into the system Python
7676
when using virtual environments is a common approach to working around this
7777
limitation.
7878

79-
The :term:`wheel` project also provides a :command:`wheel convert` subcommand that can
79+
The :term:`Wheel` project also provides a :command:`wheel convert` subcommand that can
8080
convert a Windows :command:`bdist_wininst` installer to a wheel.
8181

8282
.. preserve old links to this heading

source/guides/migrating-to-pypi-org.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Migrating to PyPI.org
44
=====================
55

6-
:term:`PyPI.org` is the new, rewritten version of PyPI that has replaced the
6+
:term:`pypi.org` is the new, rewritten version of PyPI that has replaced the
77
legacy PyPI code base. It is the default version of PyPI that people are
88
expected to use. These are the tools and processes that people will need to
99
interact with ``PyPI.org``.

source/overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Python source distributions
7979

8080
If your code consists of multiple Python files, it's usually organized
8181
into a directory structure. Any directory containing Python files can
82-
comprise an :term:`import package`.
82+
comprise an :term:`Import Package`.
8383

8484
Because packages consist of multiple files, they are harder to
8585
distribute. Most protocols support transferring only one file at a
@@ -90,7 +90,7 @@ to guarantee code integrity at the destination.
9090
So long as your code contains nothing but pure Python code, and you
9191
know your deployment environment supports your version of Python, then
9292
you can use Python's native packaging tools to create a *source*
93-
:term:`distribution package`, or *sdist* for short.
93+
:term:`Distribution Package`, or *sdist* for short.
9494

9595
Python's *sdists* are compressed archives (``.tar.gz`` files)
9696
containing one or more packages or modules. If your code is
@@ -124,7 +124,7 @@ in C, C++, Fortran, Rust, and other languages.
124124

125125
Not all developers have the right tools or experiences to build these
126126
components written in these compiled languages, so Python created the
127-
:term:`wheel`, a package format designed to ship libraries with
127+
:term:`Wheel`, a package format designed to ship libraries with
128128
compiled artifacts. In fact, Python's package installer, ``pip``,
129129
always prefers wheels because installation is always faster, so even
130130
pure-Python packages work better with wheels.

source/tutorials/packaging-projects.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A simple project
1010
----------------
1111

1212
This tutorial uses a simple project named ``example_pkg``. If you are unfamiliar
13-
with Python's modules and :term:`import packages <import package>`, take a few
13+
with Python's modules and :term:`import packages <Import Package>`, take a few
1414
minutes to read over the `Python documentation for packages and modules`_. Even if you already have a project that you want to package up, we recommend following this tutorial as-is using this example package and then trying with your own package.
1515

1616
To create this project locally, create the following file structure:
@@ -112,7 +112,7 @@ minimal set:
112112
will just be a link to GitHub, GitLab, Bitbucket, or similar code hosting
113113
service.
114114
- ``packages`` is a list of all Python :term:`import packages <Import
115-
Package>` that should be included in the :term:`distribution package`.
115+
Package>` that should be included in the :term:`Distribution Package`.
116116
Instead of listing each package manually, we can use :func:`find_packages`
117117
to automatically discover all packages and subpackages. In this case, the
118118
list of packages will be ``example_pkg`` as that's the only package present.
@@ -181,8 +181,8 @@ MIT license:
181181
Generating distribution archives
182182
--------------------------------
183183

184-
The next step is to generate :term:`distribution packages <distribution
185-
package>` for the package. These are archives that are uploaded to the Package
184+
The next step is to generate :term:`distribution packages <Distribution
185+
Package>` for the package. These are archives that are uploaded to the Package
186186
Index and can be installed by :ref:`pip`.
187187

188188
Make sure you have the latest versions of ``setuptools`` and ``wheel``
@@ -217,8 +217,8 @@ files in the :file:`dist` directory:
217217
https://github.com/pypa/packaging-problems/issues/new?title=Trouble+following+packaging+libraries+tutorial
218218

219219

220-
The ``tar.gz`` file is a :term:`source archive` whereas the ``.whl`` file is a
221-
:term:`built distribution`. Newer :ref:`pip` versions preferentially install
220+
The ``tar.gz`` file is a :term:`Source Archive` whereas the ``.whl`` file is a
221+
:term:`Built Distribution`. Newer :ref:`pip` versions preferentially install
222222
built distributions, but will fall back to source archives if needed. You
223223
should always upload a source archive and provide built archives for the
224224
platforms your project is compatible with. In this case, our example package is
@@ -322,7 +322,8 @@ and from the interpreter shell import the package:
322322
323323
>>> import example_pkg
324324
325-
Note that the :term:`import package` is ``example_pkg`` regardless of what name you gave your :term:`distribution package`
325+
Note that the :term:`Import Package` is ``example_pkg`` regardless of what
326+
name you gave your :term:`Distribution Package`
326327
in :file:`setup.py` (in this case, ``example-pkg-YOUR-USERNAME-HERE``).
327328

328329
Next steps

0 commit comments

Comments
 (0)