Skip to content

Prevent make venv from reporting success when it actually failed #1611

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 6 commits into from
Jul 19, 2025
Merged

Prevent make venv from reporting success when it actually failed #1611

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
96f1ef6
prevent `make venv` from falsely reporting success
nachocab Jul 19, 2025
321eb50
improve initial requirement docs
nachocab Jul 19, 2025
b935225
fix location of `set -e`
nachocab Jul 19, 2025
235c4d1
Fix docs
nachocab Jul 19, 2025
620d9e9
make it clear that it's an optional step
nachocab Jul 19, 2025
eed589c
explain that the second step is also optional
nachocab Jul 19, 2025
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 Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ venv:

.PHONY: ensure-venv
ensure-venv:
set -e;
@if [ ! -d $(VENVDIR) ] ; then \
echo "Creating venv in $(VENVDIR)"; \
if $(UV) --version >/dev/null 2>&1; then \
Expand Down
20 changes: 16 additions & 4 deletions documentation/start-documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,24 @@ To build the documentation, follow the steps in one of the sections below.
You can view the documentation after building the HTML
by opening the file :file:`Doc/build/html/index.html` in a web browser.

.. note::
.. _doc-initial-requirements:

Initial requirements
--------------------


Ensure your current working dir is the ``Doc`` subdirectory in your
:ref:`CPython repository clone <checkout>`.

.. code-block:: shell

cd Doc

Ensure your Python version is at least 3.11 (Sphinx requirement).

The following instructions all assume your current working dir is
the ``Doc`` subdirectory in your :ref:`CPython repository clone <checkout>`.
Make sure to switch to it with ``cd Doc`` if necessary.
.. code-block:: shell

python --version

.. _doc-create-venv:

Expand Down