• Home
  • Raw
  • Download

Lines Matching +full:build +full:- +full:with +full:- +full:python

1 Python Documentation README
4 This directory contains the reStructuredText (reST) sources to the Python
5 documentation. You don't need to build them yourself, `prebuilt versions are
6 available <https://docs.python.org/dev/download.html>`_.
8 Documentation on authoring Python documentation, including information about
9 both style and markup, is available in the "`Documenting Python
10 <https://devguide.python.org/documenting/>`_" chapter of the
17 The documentation is built with several tools which are not included in this
23 * `python-docs-theme <https://pypi.org/project/python-docs-theme/>`_
29 ----------
31 To get started on UNIX, you can create a virtual environment and build
32 documentation with the commands::
38 necessary to build the documentation downloaded and installed from PyPI.
43 the Makefile will look for instances of ``sphinx-build`` and ``blurb``
44 installed on your process ``PATH`` (configurable with the ``SPHINXBUILD`` and
47 On Windows, we try to emulate the Makefile as closely as possible with a
48 ``make.bat`` file. If you need to specify the Python interpreter to use,
49 set the PYTHON environment variable.
53 * "clean", which removes all build files and the virtual environment.
55 * "clean-venv", which removes the virtual environment directory.
57 * "venv", which creates a virtual environment with all necessary tools
62 * "htmlview", which re-uses the "html" builder, but then opens the main page
66 convert them into a single Compiled HTML (.chm) file -- these are popular
78 * "epub", which builds an EPUB document, suitable to be viewed on e-book
83 well as a plain-text (.txt) file.
92 * "pydoc-topics", which builds a Python module containing a dictionary with
94 ``tools/pyspecific.py`` -- pydoc needs these to show topic and keyword help.
101 * "serve", which serves the build/html directory on port 8000.
108 ------------
114 sphinx-build -b<builder> . build/<builder>
133 `Python bug tracker <https://github.com/python/cpython/issues>`_.
137 You can also send a mail to the Python Documentation Team at docs@python.org,
141 a mail to docs@python.org.