A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://python.github.io/peps/docs/build below:

Building PEPs Locally | peps.python.org

Python Enhancement Proposals Building PEPs Locally

Whilst editing a PEP, it is useful to review the rendered output locally. This can also be used to check that the PEP is valid reStructuredText before submission to the PEP editors.

The rest of this document assumes you are working from a local clone of the PEPs repository, with Python 3.9 or later installed.

Render PEPs locally
  1. Create a virtual environment and install requirements:

    If you don’t have access to make, run:

    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.
  3. Run the build script:

    If you don’t have access to make, run:

    (venv) PS> python build.py
    
  4. Navigate to the build directory of your PEPs repo to find the HTML pages. PEP 0 provides a formatted index, and may be a useful reference.
build.py tools

Several additional tools can be run through build.py, or the Makefile.

Note that before using build.py you must activate the virtual environment created earlier:

source .venv/bin/activate

Or on Windows:

PS> .\.venv\Scripts\activate
Check links

Check the validity of links within PEP sources (runs the Sphinx linkchecker).

python build.py --check-links
make linkcheck
build.py usage

For details on the command-line options to the build.py script, run:


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4