Skip to content

Document the htmlview make target. #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2022
Merged

Document the htmlview make target. #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docquality.rst
View file
Open in desktop
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
View file
Open in desktop
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