Skip to content
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

Jump to bottom

📚 [reference] Fix broken cross-references to Poetry documentation #738

Merged
merged 1 commit into from
May 17, 2022
Merged

📚 [reference] Fix broken cross-references to Poetry documentation #738

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
19 changes: 8 additions & 11 deletions src/nox_poetry/sessions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,17 +199,15 @@ def installroot(
def export_requirements(self) -> Path:
"""Export a requirements file from Poetry.

This function uses `poetry export`_ to generate a :ref:`requirements
file <Requirements Files>` containing the project dependencies at the
versions specified in ``poetry.lock``. The requirements file includes
both core and development dependencies.
This function uses `poetry export <https://python-poetry.org/docs/cli/#export>`_
to generate a :ref:`requirements file <Requirements Files>` containing the
project dependencies at the versions specified in ``poetry.lock``. The
requirements file includes both core and development dependencies.

The requirements file is stored in a per-session temporary directory,
together with a hash digest over ``poetry.lock`` to avoid generating the
file when the dependencies have not changed since the last run.

.. _poetry export: https://python-poetry.org/docs/cli/#export

Returns:
The path to the requirements file.
"""
Expand Down Expand Up @@ -237,11 +235,10 @@ def build_package(
) -> str:
"""Build a distribution archive for the package.

This function uses `poetry build`_ to build a wheel or sdist archive for
the local package, as specified via the ``distribution_format`` parameter.
It returns a file URL with the absolute path to the built archive.

.. _poetry build: https://python-poetry.org/docs/cli/#export
This function uses `poetry build <https://python-poetry.org/docs/cli/#build>`_
to build a wheel or sdist archive for the local package, as specified via the
``distribution_format`` parameter. It returns a file URL with the absolute path
to the built archive.

Args:
distribution_format: The distribution format, either wheel or sdist.
Expand Down