Skip to content

Improve "further reading" at end of "packaging projects" tutorial #1432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Improve "further reading" at end of "packaging projects" tutorial #1432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@
"dh-virtualenv": ("https://dh-virtualenv.readthedocs.io/en/latest/", None),
"distlib": ("https://distlib.readthedocs.io/en/latest/", None),
"flexx": ("https://flexx.readthedocs.io/en/latest/", None),
"flit": ("https://flit.pypa.io/en/stable/", None),
"nox": ("https://nox.thea.codes/en/latest/", None),
"openstack": ("https://docs.openstack.org/glance/latest/", None),
"packaging": ("https://packaging.pypa.io/en/latest/", None),
Expand Down
16 changes: 11 additions & 5 deletions source/tutorials/packaging-projects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,14 +529,16 @@ differences:
At this point if you want to read more on packaging Python libraries here are
some things you can do:

.. TODO: Add links to other guides
.. TODO: Add links to backend configuration docs

* Read about advanced configuration for your chosen build backend:
`Hatchling <hatchling-config_>`_,
:doc:`setuptools <setuptools:userguide/pyproject_config>`,
:doc:`Flit <flit:pyproject_toml>`, `PDM <pdm-config_>`_.
* Look at the :doc:`guides </guides/index>` on this site for more advanced
practical information, or the :doc:`discussions </discussions/index>`
for explanations and background on specific topics.
* Consider packaging tools that provide a single command-line interface for
project management and packaging, such as :ref:`hatch`, :ref:`flit`,
:ref:`pdm`, and :ref:`poetry`.
* Read :pep:`517` and :pep:`518` for background and details on build tool configuration.
* Read about :doc:`/guides/packaging-binary-extensions`.


----
Expand All @@ -549,3 +551,7 @@ some things you can do:
and considered an **advanced topic** (not covered in this tutorial).
If you are only getting started with Python packaging, it is recommended to
stick with *regular packages* and ``__init__.py`` (even if the file is empty).


.. _hatchling-config: https://hatch.pypa.io/latest/config/metadata/
.. _pdm-config: https://pdm-project.org/latest/reference/pep621/