diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-08-02 12:21:14 +0100 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-08-02 12:38:21 +0100 |
| commit | ab8e0330be999ef4b745861db0280a40eae3048b (patch) | |
| tree | 8cceab502c6ebd30410b0761e4319eef0c216def /docs | |
| parent | d0d8b6360413696c10e3a6d485dad3cb2524561d (diff) | |
| parent | 9b0cf7e1dfd8c3e11a47a9b3c7f4385745d50daf (diff) | |
| download | python-setuptools-git-ab8e0330be999ef4b745861db0280a40eae3048b.tar.gz | |
Merge branch 'main' into feature/pep660
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 16 | ||||
| -rw-r--r-- | docs/deprecated/commands.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/quickstart.rst | 6 |
3 files changed, 20 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index b7d05382..9a4e33b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,6 +102,19 @@ intersphinx_mapping.update({ ), }) +# Support tooltips on references +extensions += ['hoverxref.extension'] +hoverxref_auto_ref = True +hoverxref_intersphinx = [ + 'python', + 'pip', + 'build', + 'PyPUG', + 'packaging', + 'twine', + 'importlib-resources', +] + # Add support for linking usernames github_url = 'https://github.com' github_repo_org = 'pypa' @@ -202,6 +215,9 @@ extensions += ['jaraco.tidelift'] extensions += ['sphinx-favicon'] html_static_path = ['images'] # should contain the folder with icons +# Add support for nice Not Found 404 pages +extensions += ['notfound.extension'] + # List of dicts with <link> HTML attributes # static-file points to files in the html_static_path (href is computed) favicons = [ diff --git a/docs/deprecated/commands.rst b/docs/deprecated/commands.rst index ebd0687a..d9d97a9e 100644 --- a/docs/deprecated/commands.rst +++ b/docs/deprecated/commands.rst @@ -15,7 +15,7 @@ You could also run commands in other circumstances: * ``setuptools`` projects without ``setup.py`` (e.g., ``setup.cfg``-only):: - python -c "import setuptools; setup()" --help + python -c "from setuptools import setup; setup()" --help * ``distutils`` projects (with a ``setup.py`` importing ``distutils``):: diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 6c39c352..060288d8 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -118,7 +118,7 @@ distributing into something that looks like the following mypackage ├── pyproject.toml - | # setup.cfg or setup.py (depending on the confuguration method) + | # setup.cfg or setup.py (depending on the configuration method) | # README.rst or README.md (a nice description of your package) | # LICENCE (properly chosen license information, e.g. MIT, BSD-3, GPL-3, MPL-2, etc...) └── mypackage @@ -186,9 +186,9 @@ found, as shown in the example below: .. code-block:: ini [options] - packages = find: # OR `find_namespaces:` if you want to use namespaces + packages = find: # OR `find_namespace:` if you want to use namespaces - [options.packages.find] # (always `find` even if `find_namespaces:` was used before) + [options.packages.find] # (always `find` even if `find_namespace:` was used before) # This section is optional # Each entry in this section is optional, and if not specified, the default values are: # `where=.`, `include=*` and `exclude=` (empty). |