Skip to content

docs: clarify what the package provides #366

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

Open
henryiii wants to merge 2 commits into
base: master
Choose a base branch
from
+10 −3
Open

docs: clarify what the package provides #366

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d73ec5a
docs: clarify what the package provides
henryiii Sep 1, 2026
5d4ae39
Apply suggestion from @henryiii
henryiii Sep 1, 2026
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
13 changes: 10 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,23 @@ Ninja Python Distributions
The latest Ninja python wheels provide `ninja 1.13.2.g7659b.kitware.jobserver-pipe-1 <https://ninja-build.org/manual.html>`_ executable
and `ninja_syntax.py` for generating `.ninja` files.

The classes in ninja_syntax are in the ninja namespace, so are accesable via ``import ninja``, e.g. ::
The classes in ninja_syntax are in the ninja namespace, so are accessible via ``import ninja``, e.g. ::

import ninja
writer = ninja.Writer(sys.stdout)

This package also installs a front-end to the nijnja executable, so that::
This package also installs a front-end to the ninja executable, so that::

python -m ninja

will call the executable.
will call the executable. You can also call it from Python with ``ninja.ninja()``,
which forwards ``sys.argv`` and exits with the ninja return code. The directory that
holds the executable is available as ``ninja.BIN_DIR``.

The package does not provide Python bindings to the ninja build engine itself. It only
distributes the executable and the upstream ``ninja_syntax.py`` helper. Since
this is only a redistribution, and should not be required if ninja is already
present, it is not the right place for bindings.

.. image:: https://raw.githubusercontent.com/scikit-build/ninja-python-distributions/master/ninja-python-distributions-logo.png

Expand Down
Loading