Merge branch 'main' into added_obsolete

Author: venthur

.github/workflows/test.yml

@@ -1,6 +1,10 @@
 name: Test
 
-on: [push, pull_request]
+on: 
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 6 * * *" # daily at 6am
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
@@ -9,6 +13,7 @@ concurrency:
 jobs:
   build:
     name: ${{ matrix.noxenv }}
+    if: ${{ github.repository_owner == 'pypa' || github.event_name != 'schedule' }}
     runs-on: ubuntu-latest
     strategy:
       matrix:

.readthedocs.yaml

@@ -9,7 +9,11 @@ sphinx:
    # https://github.com/pyca/cryptography/issues/5863#issuecomment-792343136
    builder: dirhtml
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 python:
-   version: 3.8
    install:
    - requirements: requirements.txt

requirements.txt

@@ -3,4 +3,4 @@ sphinx-autobuild==0.7.1
 sphinx-inline-tabs==2021.4.11b9
 python-docs-theme==2022.1
 sphinx-copybutton==0.5.0
-git+https://github.com/pypa/pypa-docs-theme.git#egg=pypa-docs-theme
+pypa-docs-theme @ git+https://github.com/pypa/pypa-docs-theme.git

source/conf.py

@@ -397,6 +397,7 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'boltons': ('https://boltons.readthedocs.io/en/latest/', None),
+    'bottle': ('https://bottlepy.org/docs/dev/', None),
     'build': ('https://pypa-build.readthedocs.io/en/stable/', None),
     'cffi': ('https://cffi.readthedocs.io/en/latest/', None),
     'conda': ('https://conda.io/en/latest/', None),
@@ -407,7 +408,7 @@
     'nox': ('https://nox.thea.codes/en/latest/', None),
     'openstack': ('https://docs.openstack.org/glance/latest/', None),
     'packaging': ('https://packaging.pypa.io/en/latest/', None),
-    'packaging.python.org': ('https://packaging.python.org/', None),
+    'packaging.python.org': ('https://packaging.python.org/en/latest/', None),
     'pip': ('https://pip.pypa.io/en/latest/', None),
     'pipenv': ('https://pipenv.pypa.io/en/latest/', None),
     'piwheels': ('https://piwheels.readthedocs.io/en/latest/', None),
@@ -416,10 +417,10 @@
     'pypa': ('https://www.pypa.io/en/latest/', None),
     'python': ('https://docs.python.org/3', None),
     'python-guide': ('https://docs.python-guide.org', None),
-    'setuptools': ('https://setuptools.readthedocs.io/en/latest/', None),
+    'setuptools': ('https://setuptools.pypa.io/en/latest/', None),
     'spack': ('https://spack.readthedocs.io/en/latest/', None),
     'sphinx': ('https://www.sphinx-doc.org/en/master', None),
-    'tox': ('https://tox.readthedocs.io/en/latest/', None),
+    'tox': ('https://tox.wiki/en/latest/', None),
     'twine': ('https://twine.readthedocs.io/en/stable/', None),
     'virtualenv': ('https://virtualenv.pypa.io/en/stable/', None),
 }

source/discussions/install-requires-vs-requirements.rst

@@ -38,8 +38,9 @@ v2 of 'B', so it would be like so:
     'B>=2'
  ]
 
-It may also be known that project A follows semantic versioning, and that v2 of
-'A' will indicate a break in compatibility, so it makes sense to not allow v2:
+It may also be known that project 'A' introduced a change in its v2
+that breaks the compatibility of your project with v2 of 'A' and later,
+so it makes sense to not allow v2:
 
 ::
 

source/discussions/wheel-vs-egg.rst

@@ -17,7 +17,9 @@ Distribution>` and :term:`binary <Binary Distribution>` packaging for Python.
 Here's a breakdown of the important differences between :term:`Wheel` and :term:`Egg`.
 
 
-* :term:`Wheel` has an :pep:`official PEP <427>`. :term:`Egg` did not.
+* :term:`Wheel` has an :doc:`official standard specification
+  </specifications/binary-distribution-format>`.
+  :term:`Egg` did not.
 
 * :term:`Wheel` is a :term:`distribution <Distribution Package>` format, i.e a packaging
   format. [1]_ :term:`Egg` was both a distribution format and a runtime
@@ -45,5 +47,5 @@ Here's a breakdown of the important differences between :term:`Wheel` and :term:
 ----
 
 .. [1] Circumstantially, in some cases, wheels can be used as an importable
-       runtime format, although :pep:`this is not officially supported at this time
-       <427#is-it-possible-to-import-python-code-directly-from-a-wheel-file>`.
+       runtime format, although :ref:`this is not officially supported at this time
+       <binary-distribution-format-import-wheel>`.

source/glossary.rst

@@ -42,7 +42,7 @@ Glossary
     Egg
 
         A :term:`Built Distribution` format introduced by :ref:`setuptools`,
-        which is being replaced by :term:`Wheel`.  For details, see `
+        which is being replaced by :term:`Wheel`.  For details, see 
         :doc:`The Internal Structure of Python Eggs <setuptools:deprecated/python_eggs>` and
         `Python Eggs <http://peak.telecommunity.com/DevCenter/PythonEggs>`_
 
@@ -237,7 +237,9 @@ Glossary
 
     Wheel
 
-        A :term:`Built Distribution` format introduced by :pep:`427`,
+        A :term:`Built Distribution` format introduced by an official
+        :doc:`standard specification
+        </specifications/binary-distribution-format/>`,
         which is intended to replace the :term:`Egg` format.  Wheel is currently
         supported by :ref:`pip`.
 

source/guides/analyzing-pypi-package-downloads.rst

@@ -94,7 +94,7 @@ Useful queries
 
 Run queries in the `BigQuery web UI`_ by clicking the "Compose query" button.
 
-Note that the rows are stored in a partitioned, which helps
+Note that the rows are stored in a partitioned table, which helps
 limit the cost of queries. These example queries analyze downloads from
 recent history by filtering on the ``timestamp`` column.
 
@@ -121,7 +121,7 @@ The following query counts the total number of downloads for the project
 | 26190085      |
 +---------------+
 
-To only count downloads from pip, filter on the ``details.installer.name``
+To count downloads from pip only, filter on the ``details.installer.name``
 column.
 
 ::
@@ -311,7 +311,7 @@ Install `pypinfo`_ using pip.
 
 .. code-block:: bash
 
-    python -m pip install pypinfo
+    python3 -m pip install pypinfo
 
 Usage:
 
@@ -343,7 +343,7 @@ References
 .. _public PyPI download statistics dataset: https://console.cloud.google.com/bigquery?p=bigquery-public-data&d=pypi&page=dataset
 .. _Google BigQuery: https://cloud.google.com/bigquery
 .. _BigQuery web UI: https://console.cloud.google.com/bigquery
-.. _pypinfo: https://github.com/ofek/pypinfo/blob/master/README.rst
+.. _pypinfo: https://github.com/ofek/pypinfo
 .. _google-cloud-bigquery: https://cloud.google.com/bigquery/docs/reference/libraries
 .. _pandas-gbq: https://pandas-gbq.readthedocs.io/en/latest/
 .. _Pandas: https://pandas.pydata.org/

source/guides/creating-and-discovering-plugins.rst

@@ -41,18 +41,17 @@ then ``discovered_plugins`` would be:
 .. code-block:: python
 
     {
-        'flask_sqlachemy': <module: 'flask_sqlalchemy'>,
+        'flask_sqlalchemy': <module: 'flask_sqlalchemy'>,
         'flask_talisman': <module: 'flask_talisman'>,
     }
 
-Using naming convention for plugins also allows you to query the
-Python Package Index's `simple API`_ for all packages that conform to your
-naming convention.
+Using naming convention for plugins also allows you to query
+the Python Package Index's :ref:`simple repository API <simple-repository-api>`
+for all packages that conform to your naming convention.
 
 .. _Flask: https://pypi.org/project/Flask/
 .. _Flask-SQLAlchemy: https://pypi.org/project/Flask-SQLAlchemy/
 .. _Flask-Talisman: https://pypi.org/project/flask-talisman
-.. _simple API: https://www.python.org/dev/peps/pep-0503/#specification
 
 
 Using namespace packages

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

@@ -72,7 +72,7 @@ sample project <https://github.com/pypa/sampleproject>`_.
 
 2. It's the command line interface for running various commands that
    relate to packaging tasks. To get a listing of available commands, run
-   ``python setup.py --help-commands``.
+   ``python3 setup.py --help-commands``.
 
 
 setup.cfg
@@ -677,7 +677,7 @@ Change directory to the root of the project directory and run:
 
 .. code-block:: bash
 
-   python -m pip install -e .
+   python3 -m pip install -e .
 
 
 The pip command-line flag ``-e`` is short for ``--editable``, and ``.`` refers
@@ -693,7 +693,7 @@ you want "bar" installed from VCS in editable mode, then you could construct a
 requirements file like so::
 
   -e .
-  -e git+https://somerepo/bar.git#egg=bar
+  -e bar @ git+https://somerepo/bar.git
 
 The first line says to install your project and any dependencies. The second
 line overrides the "bar" dependency, such that it's fulfilled from VCS, not
@@ -712,7 +712,7 @@ Lastly, if you don't want to install any dependencies at all, you can run:
 
 .. code-block:: bash
 
-   python -m pip install -e . --no-deps
+   python3 -m pip install -e . --no-deps
 
 
 For more information, see the
@@ -812,7 +812,7 @@ To build the wheel:
 
     .. code-block:: bash
 
-        python -m build --wheel
+        python3 -m build --wheel
 
 .. tab:: Windows