Skip to content

Commit

Permalink
Build Instructions: Fix to work with the latest Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
davidfstr committed Apr 15, 2022
1 parent 9514bd9 commit cb9d9d3
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,20 @@ installed.
Render PEPs locally
-------------------

1. Create a virtual environment and install requirements.

The rest of these instructions assume an active virtual environment named
``venv``.
The Python Packaging User Guide contains
`instructions on creating a virtual environment <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment>`__
for reference.
1. Create a virtual environment and install requirements:

.. code-block:: console
(venv) $ python -m pip install --upgrade pip
(venv) $ python -m pip install -r requirements.txt
$ make venv
If you don't have access to ``make``, run:

.. code-block:: ps1con
PS> python -m venv .venv
PS> .\.venv\Scripts\activate
(venv) PS> python -m pip install --upgrade pip
(venv) PS> python -m pip install -r requirements.txt
2. **(Optional)** Delete prior build files.
Generally only needed when making changes to the rendering system itself.
Expand All @@ -41,7 +43,7 @@ Render PEPs locally

.. code-block:: console
(venv) $ make render
$ make render
If you don't have access to ``make``, run:

Expand Down

0 comments on commit cb9d9d3

Please sign in to comment.