Skip to content

Commit 8a6dd1b

Browse files
nachocabAA-Turner
andauthored
Prevent make venv from reporting success when it actually failed (#1611)
Co-authored-by: Adam Turner <[email protected]>
1 parent 96905b4 commit 8a6dd1b

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ venv:
5858
.PHONY: ensure-venv
5959
ensure-venv:
6060
@if [ ! -d $(VENVDIR) ] ; then \
61+
set -e; \
6162
echo "Creating venv in $(VENVDIR)"; \
6263
if $(UV) --version >/dev/null 2>&1; then \
6364
$(UV) venv --python=$(PYTHON) $(VENVDIR); \

documentation/start-documenting.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,22 @@ To build the documentation, follow the steps in one of the sections below.
7676
You can view the documentation after building the HTML
7777
by opening the file :file:`Doc/build/html/index.html` in a web browser.
7878

79-
.. note::
79+
Initial requirements
80+
--------------------
81+
82+
Ensure your current working directory is the top level ``Doc/`` directory
83+
inside your :ref:`CPython repository clone <checkout>`. You can switch to
84+
it with:
85+
86+
.. code-block:: shell
87+
88+
cd Doc
89+
90+
Ensure your Python version is at least 3.11. You can verify it with:
8091

81-
The following instructions all assume your current working dir is
82-
the ``Doc`` subdirectory in your :ref:`CPython repository clone <checkout>`.
83-
Make sure to switch to it with ``cd Doc`` if necessary.
92+
.. code-block:: shell
8493
94+
python --version
8595
8696
.. _doc-create-venv:
8797

0 commit comments

Comments
 (0)