iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove build instructions from README (#2354)

This commit is contained in:
CAM Gerlach 2022-02-22 12:44:07 -06:00 committed by GitHub
parent 4e06e44f8d
commit 14fd18da9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.rst
View File

@ -105,51 +105,44 @@ There is a Sphinx-rendered version of the PEPs at https://python.github.io/peps/
(updated on every push to ``main``). (updated on every push to ``main``).
**Warning:** This version is not, and should not be taken to be, a canonical **Warning:** This version is not, and should not be taken to be, a canonical
source for PEPs whilst it remains in preview (`please report any rendering bugs source for PEPs whilst it remains in preview (please `report any rendering bugs
<https://github.com/python/peps/issues/new>`_). The canonical source for PEPs remains <https://github.com/python/peps/issues/new>`_).
https://www.python.org/dev/peps/ The canonical source for PEPs remains https://www.python.org/dev/peps/
Build PEPs with Sphinx locally:
-------------------------------
1. Ensure you have Python >=3.9 and Sphinx installed Build PEPs with Sphinx locally
2. If you have access to ``make``, follow (i), otherwise (ii) ------------------------------
i. Run ``make sphinx-local`` See the `build documentation <./docs/build.rst>`__ for full step by step
ii. Run ``python build.py -j 8 --build-files``. Note that the jobs argument instructions on how to install, build and view the rendered PEPs with Sphinx.
only takes effect on unix (non-mac) systems.
3. Wait for Sphinx to render the PEPs. There may be a series of warnings about
unreferenced citations or labels -- whilst these are valid warnings they do
not impact the build process.
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.
Arguments to ``build.py``: In summary, after installing the dependencies (preferably in a virtual
-------------------------- environment) with:
Renderers: .. code-block:: console
``-f`` or ``--build-files`` python -m pip install -r requirements.txt
Renders PEPs to ``pep-XXXX.html`` files
``-d`` or ``--build-dirs`` You can build the PEPs with sphinx by running, if your system has ``make``:
Renders PEPs to ``index.html`` files within ``pep-XXXX`` directories
Options: .. code-block:: console
``-i`` or ``--index-file`` make sphinx
Copies PEP 0 to a base index file
``-j`` or ``--jobs`` Otherwise, execute the ``build.py`` script directly:
How many parallel jobs to run (if supported). Integer, default 1
``-n`` or ``--nitpicky`` .. code-block:: console
Runs Sphinx in `nitpicky` mode
``-w`` or ``--fail-on-warning`` python build.py
Fails Sphinx on warnings
Tools: The output HTML can be found under the ``build`` directory.
``-l`` or ``--check-links``
Checks validity of links within PEP sources ``build.py`` usage
------------------
For details on the command-line options to the ``build.py`` script, run:
.. code-block:: console
python build.py --help