@@ -28,7 +28,7 @@ install the tools into there.
28
28
Using make
29
29
----------
30
30
31
- To get started on UNIX , you can create a virtual environment and build
31
+ To get started on Unix , you can create a virtual environment and build
32
32
documentation with the commands::
33
33
34
34
make venv
@@ -40,13 +40,13 @@ If you'd like to create the virtual environment in a different location,
40
40
you can specify it using the ``VENVDIR `` variable.
41
41
42
42
You can also skip creating the virtual environment altogether, in which case
43
- the Makefile will look for instances of ``sphinx-build `` and ``blurb ``
43
+ the `` Makefile `` will look for instances of ``sphinx-build `` and ``blurb ``
44
44
installed on your process ``PATH `` (configurable with the ``SPHINXBUILD `` and
45
45
``BLURB `` variables).
46
46
47
- On Windows, we try to emulate the Makefile as closely as possible with a
47
+ On Windows, we try to emulate the `` Makefile `` as closely as possible with a
48
48
``make.bat `` file. If you need to specify the Python interpreter to use,
49
- set the PYTHON environment variable.
49
+ set the `` PYTHON `` environment variable.
50
50
51
51
Available make targets are:
52
52
@@ -62,15 +62,19 @@ Available make targets are:
62
62
* "htmlview", which re-uses the "html" builder, but then opens the main page
63
63
in your default web browser.
64
64
65
+ * "htmllive", which re-uses the "html" builder, rebuilds the docs,
66
+ starts a local server, and automatically reloads the page in your browser
67
+ when you make changes to reST files (Unix only).
68
+
65
69
* "htmlhelp", which builds HTML files and a HTML Help project file usable to
66
70
convert them into a single Compiled HTML (.chm) file -- these are popular
67
71
under Microsoft Windows, but very handy on every platform.
68
72
69
73
To create the CHM file, you need to run the Microsoft HTML Help Workshop
70
- over the generated project (.hhp) file. The make.bat script does this for
74
+ over the generated project (.hhp) file. The `` make.bat `` script does this for
71
75
you on Windows.
72
76
73
- * "latex", which builds LaTeX source files as input to " pdflatex" to produce
77
+ * "latex", which builds LaTeX source files as input to `` pdflatex `` to produce
74
78
PDF documents.
75
79
76
80
* "text", which builds a plain text file for each source file.
@@ -95,8 +99,6 @@ Available make targets are:
95
99
96
100
* "check", which checks for frequent markup errors.
97
101
98
- * "serve", which serves the build/html directory on port 8000.
99
-
100
102
* "dist", (Unix only) which creates distributable archives of HTML, text,
101
103
PDF, and EPUB builds.
102
104
0 commit comments