Skip to content

Commit 4b1b00c

Browse files
authored
Document the htmlview make target (#857)
1 parent 1337af4 commit 4b1b00c

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

docquality.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,16 +120,17 @@ you*. To build the devguide on a Unix-like system use::
120120

121121
$ make html
122122

123-
in the checkout directory. On Windows use:
123+
in the checkout directory. On Windows use:
124124

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

134135
.. _separate repository:
135136
.. _devguide repo: https://github.com/python/devguide

documenting.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1544,7 +1544,9 @@ Using make / make.bat
15441544
make venv
15451545
make html
15461546

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

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

0 commit comments

Comments
 (0)