PEPs lokal erstellen
Beim Bearbeiten eines PEP ist es nützlich, das gerenderte Ergebnis lokal zu überprüfen. Dies kann auch verwendet werden, um zu überprüfen, ob der PEP gültiges reStructuredText ist, bevor er an die PEP-Editoren übermittelt wird.
Der Rest dieses Dokuments geht davon aus, dass Sie von einem lokalen Klon des PEPs-Repository aus arbeiten, mit **Python 3.9 oder höher** installiert.
PEPs lokal rendern
- Eine virtuelle Umgebung erstellen und Anforderungen installieren
make venvWenn Sie keinen Zugriff auf
makehaben, führen Sie Folgendes aus: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
- (Optional) Vorherige Build-Dateien löschen. Dies ist im Allgemeinen nur erforderlich, wenn Änderungen am Rendering-System selbst vorgenommen werden.
rm -rf build
- Build-Skript ausführen
make htmlWenn Sie keinen Zugriff auf
makehaben, führen Sie Folgendes aus:(venv) PS> python build.py
- Navigieren Sie zum Verzeichnis
buildIhres PEPs-Repos, um die HTML-Seiten zu finden. PEP 0 bietet einen formatierten Index und kann eine nützliche Referenz sein.
build.py-Tools
Mehrere zusätzliche Tools können über build.py oder das Makefile ausgeführt werden.
Beachten Sie, dass Sie vor der Verwendung von build.py die zuvor erstellte virtuelle Umgebung aktivieren müssen.
source .venv/bin/activate
Oder unter Windows
PS> .\.venv\Scripts\activate
Links überprüfen
Überprüfen Sie die Gültigkeit von Links innerhalb von PEP-Quellen (führt den Sphinx Linkchecker aus).
python build.py --check-links
make linkcheck
build.py-Nutzung
Details zu den Befehlszeilenoptionen des build.py-Skripts erhalten Sie, indem Sie Folgendes ausführen:
python build.py --help