Skip to content
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

Document 'make htmllive' #1219

Merged
merged 2 commits into from
Nov 15, 2023
Merged

Document 'make htmllive' #1219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
019c414
Document 'make htmllive'
hugovk Nov 14, 2023
058fce5
Reword
hugovk Nov 15, 2023
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
12 changes: 9 additions & 3 deletions documentation/devguide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,15 @@ in the checkout directory. On Windows use:

> .\make html

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
You will find the generated files in ``_build/html``.

.. tip:: * Replace ``html`` with ``htmlview`` to open the docs in a web browser
once the build completes.
* Replace ``html`` with ``htmllive`` to rebuild the docs,
start a local server, and automatically reload the page in your
browser when you make changes to reST files (Unix only).

Note that ``make check`` runs automatically when you submit
a :ref:`pull request <pullrequest>`. You may wish to run ``make check``
and ``make linkcheck`` to make sure that it runs without errors.

Expand Down
7 changes: 5 additions & 2 deletions documentation/start-documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,11 @@ To build the docs as HTML, run::

make html

.. tip:: Substitute ``htmlview`` for ``html`` to open the docs in a web browser
once the build completes.
.. tip:: * Replace ``html`` with ``htmlview`` to open the docs in a web browser
once the build completes.
* Replace ``html`` with ``htmllive`` to rebuild the docs,
start a local server, and automatically reload the page in your
browser when you make changes to reST files (Unix only).

To check the docs for common errors with `Sphinx Lint`_
(which is run on all :ref:`pull requests <pullrequest>`), use::
Expand Down