File tree Expand file tree Collapse file tree 2 files changed +14
-5
lines changed Expand file tree Collapse file tree 2 files changed +14
-5
lines changed Original file line number Diff line number Diff line change @@ -42,9 +42,15 @@ in the checkout directory. On Windows use:
42
42
43
43
> .\make html
44
44
45
- You will find the generated files in ``_build/html `` or, if you use
46
- ``make htmlview ``, the docs will be opened in a browser once the build
47
- completes. Note that ``make check `` runs automatically when you submit
45
+ You will find the generated files in ``_build/html ``.
46
+
47
+ .. tip :: * Replace ``html`` with ``htmlview`` to open the docs in a web browser
48
+ once the build completes.
49
+ * Replace ``html `` with ``htmllive `` to rebuild the docs,
50
+ start a local server, and automatically reload the page in your
51
+ browser when you make changes to reST files (Unix only).
52
+
53
+ Note that ``make check `` runs automatically when you submit
48
54
a :ref: `pull request <pullrequest >`. You may wish to run ``make check ``
49
55
and ``make linkcheck `` to make sure that it runs without errors.
50
56
Original file line number Diff line number Diff line change @@ -122,8 +122,11 @@ To build the docs as HTML, run::
122
122
123
123
make html
124
124
125
- .. tip :: Substitute ``htmlview`` for ``html`` to open the docs in a web browser
126
- once the build completes.
125
+ .. tip :: * Replace ``html`` with ``htmlview`` to open the docs in a web browser
126
+ once the build completes.
127
+ * Replace ``html `` with ``htmllive `` to rebuild the docs,
128
+ start a local server, and automatically reload the page in your
129
+ browser when you make changes to reST files (Unix only).
127
130
128
131
To check the docs for common errors with `Sphinx Lint `_
129
132
(which is run on all :ref: `pull requests <pullrequest >`), use::
You can’t perform that action at this time.
0 commit comments