Skip to content

Commit 2939857

Browse files
committed
improve initial requirement docs
1 parent 0e28413 commit 2939857

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

documentation/start-documenting.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,24 @@ 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+
.. _doc-initial-requirements:
80+
81+
Initial requirements
82+
--------------------
83+
84+
85+
Ensure your current working dir is the ``Doc`` subdirectory in your
86+
:ref:`CPython repository clone <checkout>`.
87+
88+
.. code-block:: shell
89+
90+
cd Doc
91+
92+
Ensure your Python version is at least 3.11 (Sphinx requirement).
8093

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.
94+
.. code-block:: shell
8495
96+
python --version
8597
8698
.. _doc-create-venv:
8799

0 commit comments

Comments
 (0)