Skip to content

Commit 43b800f

Browse files
JulienPalardMariatta
authored andcommitted
Documenting: Mention blurb as a doc build dependency. (GH-328)
1 parent 90adf6b commit 43b800f

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

documenting.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1467,8 +1467,9 @@ To build the documentation, follow the instructions from one of the sections
14671467
below. You can view the documentation after building the HTML by pointing
14681468
a browser at the file :file:`Doc/build/html/index.html`.
14691469

1470-
You are expected to have installed the latest stable version of Sphinx_ on
1471-
your system or in a virtualenv_, so that the Makefile can find the
1470+
You are expected to have installed the latest stable version of
1471+
Sphinx_ and blurb_ on your system or in a virtualenv_ (which can be
1472+
created using ``make venv``), so that the Makefile can find the
14721473
``sphinx-build`` command. You can also specify the location of
14731474
``sphinx-build`` with the ``SPHINXBUILD`` :command:`make` variable.
14741475

@@ -1480,9 +1481,10 @@ Using make / make.bat
14801481
<checkout>` to build the output as HTML::
14811482

14821483
cd Doc
1484+
make venv
14831485
make html
14841486

1485-
or alternatively ``make -C Doc html``.
1487+
or alternatively ``make -C Doc/ venv html``.
14861488

14871489
You can also use ``make help`` to see a list of targets supported by
14881490
:command:`make`. Note that ``make check`` is automatically run when
@@ -1498,7 +1500,7 @@ See also :file:`Doc/README.rst` for more information.
14981500
Without make
14991501
------------
15001502

1501-
Install the Sphinx package and its dependencies from PyPI.
1503+
Install the Sphinx and blurb packages from PyPI.
15021504

15031505
Then, from the ``Doc`` directory, run::
15041506

@@ -1512,3 +1514,4 @@ see the make targets above).
15121514
.. _Pygments: http://pygments.org/
15131515
.. _Sphinx: http://sphinx-doc.org/
15141516
.. _virtualenv: https://virtualenv.pypa.io/
1517+
.. _blurb: https://pypi.org/project/blurb/

0 commit comments

Comments
 (0)