Skip to content

Commit

Permalink
Undocument the removed serve target, update spelling/formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Jun 18, 2024
1 parent 093db2e commit 2e36a73
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions Doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ install the tools into there.
Using make
----------

To get started on UNIX, you can create a virtual environment and build
To get started on Unix, you can create a virtual environment and build
documentation with the commands::

make venv
Expand All @@ -40,13 +40,13 @@ If you'd like to create the virtual environment in a different location,
you can specify it using the ``VENVDIR`` variable.

You can also skip creating the virtual environment altogether, in which case
the Makefile will look for instances of ``sphinx-build`` and ``blurb``
the ``Makefile`` will look for instances of ``sphinx-build`` and ``blurb``
installed on your process ``PATH`` (configurable with the ``SPHINXBUILD`` and
``BLURB`` variables).

On Windows, we try to emulate the Makefile as closely as possible with a
On Windows, we try to emulate the ``Makefile`` as closely as possible with a
``make.bat`` file. If you need to specify the Python interpreter to use,
set the PYTHON environment variable.
set the ``PYTHON`` environment variable.

Available make targets are:

Expand Down Expand Up @@ -99,8 +99,6 @@ Available make targets are:

* "check", which checks for frequent markup errors.

* "serve", which serves the build/html directory on port 8000.

* "dist", (Unix only) which creates distributable archives of HTML, text,
PDF, and EPUB builds.

Expand Down

0 comments on commit 2e36a73

Please sign in to comment.