diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build_meta.rst | 6 | ||||
| -rw-r--r-- | docs/deprecated/distutils/commandref.rst | 2 | ||||
| -rw-r--r-- | docs/deprecated/distutils/configfile.rst | 1 | ||||
| -rw-r--r-- | docs/deprecated/distutils/extending.rst | 2 | ||||
| -rw-r--r-- | docs/deprecated/zip_safe.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/development_mode.rst | 6 | ||||
| -rw-r--r-- | docs/userguide/entry_point.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/quickstart.rst | 2 |
8 files changed, 9 insertions, 14 deletions
diff --git a/docs/build_meta.rst b/docs/build_meta.rst index 3c778d80..37738b8f 100644 --- a/docs/build_meta.rst +++ b/docs/build_meta.rst @@ -48,8 +48,8 @@ files, a ``pyproject.toml`` file and a ``setup.cfg`` file:: pyproject.toml setup.cfg meowpkg/ - __init__.py - module.py + __init__.py + module.py The ``pyproject.toml`` file specifies the build system (i.e. what is being used to package your scripts and install from source). To use it with @@ -161,7 +161,7 @@ requirements. and :pypi:`setuptools-svn`), or by correctly setting up :ref:`MANIFEST.in <manifest>`. - The generated ``.tar.gz`` and ``.whl`` files are compressed archives that + The generated ``.tar.gz`` and ``.whl`` files are compressed archives that can be inspected as follows: On POSIX systems, this can be done with ``tar -tf dist/*.tar.gz`` and ``unzip -l dist/*.whl``. diff --git a/docs/deprecated/distutils/commandref.rst b/docs/deprecated/distutils/commandref.rst index 3e247e68..d02b38c3 100644 --- a/docs/deprecated/distutils/commandref.rst +++ b/docs/deprecated/distutils/commandref.rst @@ -101,5 +101,3 @@ anything except backslash or colon. .. % \subsection{\protect\command{bdist}} .. % \subsection{\protect\command{bdist\_dumb}} .. % \subsection{\protect\command{bdist\_rpm}} - - diff --git a/docs/deprecated/distutils/configfile.rst b/docs/deprecated/distutils/configfile.rst index 2a0fbb31..ab199dca 100644 --- a/docs/deprecated/distutils/configfile.rst +++ b/docs/deprecated/distutils/configfile.rst @@ -142,4 +142,3 @@ split across multiple lines for readability. .. [#] This ideal probably won't be achieved until auto-configuration is fully supported by the Distutils. - diff --git a/docs/deprecated/distutils/extending.rst b/docs/deprecated/distutils/extending.rst index c99d3c79..fc494616 100644 --- a/docs/deprecated/distutils/extending.rst +++ b/docs/deprecated/distutils/extending.rst @@ -94,5 +94,3 @@ to add ``(command, filename)`` pairs to ``self.distribution.dist_files`` so that :command:`upload` can upload it to PyPI. The *filename* in the pair contains no path information, only the name of the file itself. In dry-run mode, pairs should still be added to represent what would have been created. - - diff --git a/docs/deprecated/zip_safe.rst b/docs/deprecated/zip_safe.rst index 08a13334..26b45662 100644 --- a/docs/deprecated/zip_safe.rst +++ b/docs/deprecated/zip_safe.rst @@ -62,7 +62,7 @@ Currently, popular Python package installers (such as :pypi:`pip`) and package indexes (such as PyPI_) consider that distribution packages are always installed as a directory. It is however still possible to load packages from zip files added to -:obj:`sys.path`, thanks to the :mod:`zipimport` module +:obj:`sys.path`, thanks to the :mod:`zipimport` module and the :mod:`importlib` machinery provided by Python standard library. When working with modules loaded from a zip file, it is important to keep in diff --git a/docs/userguide/development_mode.rst b/docs/userguide/development_mode.rst index 1716e0af..6f9f5417 100644 --- a/docs/userguide/development_mode.rst +++ b/docs/userguide/development_mode.rst @@ -17,7 +17,7 @@ without requiring a new installation. You can enter this "development mode" by performing an :doc:`editable installation <pip:topics/local-project-installs>` inside of a :term:`virtual environment`, -using :doc:`pip's <pip:cli/pip_install>` ``-e/--editable`` flag, as shown bellow: +using :doc:`pip's <pip:cli/pip_install>` ``-e/--editable`` flag, as shown below: .. code-block:: bash @@ -69,7 +69,7 @@ Please have a look on the following section if you are looking for a different b sudo apt install python3-venv - Alternatively, you can also try installing :pypi:`virtualená´ `. + Alternatively, you can also try installing :pypi:`virtualenv`. More information is available on the Python Packaging User Guide on :doc:`PyPUG:guides/installing-using-pip-and-virtual-environments`. @@ -93,7 +93,7 @@ expectations: Unfortunately these expectations are in conflict with each other. To solve this problem ``setuptools`` allows developers to choose a more *"strict"* mode for the editable installation. This can be done by passing -a special *configuration setting* via :pypi:`pip`, as indicated bellow: +a special *configuration setting* via :pypi:`pip`, as indicated below: .. code-block:: bash diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst index 6ba00287..163ce1d9 100644 --- a/docs/userguide/entry_point.rst +++ b/docs/userguide/entry_point.rst @@ -89,7 +89,7 @@ configuration: .. tab:: setup.py .. code-block:: python - + from setuptools import setup setup( diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index fe5c5bc2..bf92f6a2 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -165,7 +165,7 @@ to specify to properly package your project. :doc:`setup.cfg <declarative_config>`, and keep the ``setup.py`` minimal with only the dynamic parts (or even omit it completely if applicable). - See `Why you shouldn't invoke setup.py directly`_ for more background. + See `Why you shouldn't invoke setup.py directly`_ for more background. .. _Why you shouldn't invoke setup.py directly: https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html |