Skip to content

Commit

Permalink
Document the htmlview make target (python#857)
Browse files Browse the repository at this point in the history
  • Loading branch information
ezio-melotti authored May 6, 2022
1 parent 1337af4 commit 4b1b00c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
11 changes: 6 additions & 5 deletions docquality.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,16 +120,17 @@ you*. To build the devguide on a Unix-like system use::

$ make html

in the checkout directory. On Windows use:
in the checkout directory. On Windows use:

.. code-block:: doscon
> .\make html
You will find the generated files in ``_build/html``. Note that ``make check``
runs automatically when you submit a :doc:`pull request <pullrequest>`. You may
wish to run ``make check`` and ``make linkcheck`` to make sure that it runs
without errors.
You will find the generated files in ``_build/html`` or, if you use
``make htmlview``, the docs will be opened in a browser once the build
completes. Note that ``make check`` runs automatically when you submit
a :doc:`pull request <pullrequest>`. You may wish to run ``make check``
and ``make linkcheck`` to make sure that it runs without errors.

.. _separate repository:
.. _devguide repo: https://github.com/python/devguide
Expand Down
4 changes: 3 additions & 1 deletion documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1544,7 +1544,9 @@ Using make / make.bat
make venv
make html

or alternatively ``make -C Doc/ venv html``.
or alternatively ``make -C Doc/ venv html``. ``htmlview`` can be used
instead of ``html`` to conveniently open the docs in a browser once the
build completes.

You can also use ``make help`` to see a list of targets supported by
:command:`make`. Note that ``make check`` is automatically run when
Expand Down

0 comments on commit 4b1b00c

Please sign in to comment.