Skip to content

Commit

Permalink
Update README to reflect new capabilities.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Mar 31, 2024
1 parent c1f8474 commit 25a0b02
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

Tools for packaging.


sphinx
======

Expand All @@ -40,9 +41,14 @@ file::
extensions=['jaraco.packaging.sphinx']

The extension by default builds the project in an isolated environment in
order to extract the metadata. To build the documentation offline,
order to extract the metadata. For offline builds, set
``BUILD_ENVIRONMENT=current`` and ensure the build dependencies are
met in the current environment.

Deprecated: To build the documentation offline,
provide an already built wheel by setting the environment variable
``JARACO_PACKAGING_SPHINX_WHEEL`` to the path of the existing wheel.
``JARACO_PACKAGING_SPHINX_WHEEL`` to the path of an existing wheel.


make-tree
=========
Expand All @@ -53,3 +59,12 @@ rooted at a given package.
Usage::

pipdeptree --json | python -m jaraco.packaging.make-tree mypkg


metadata
=========

A wrapper around ``build.util.project_wheel_metadata`` to enable dowstream
packagers to indicate that they need an isolated build. Set the environment
variable ``BUILD_ENVIRONMENT=current`` to bypass build isolation and use the
current isolation for loading metadata from a project.

0 comments on commit 25a0b02

Please sign in to comment.