Skip to content

Commit

Permalink
doc: Update makefile target for docs
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Russell Bryant <[email protected]>
  • Loading branch information
stephenfin authored and russellb committed Apr 7, 2017
1 parent 1e6567d commit 1b996ac
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Documentation/intro/install/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ Building
Once Sphinx installed, the documentation can be built using the provided
Makefile targets::

$ make htmldocs
$ make htmldocs-check

.. important::

The ``htmldocs`` target will fail if there are any syntax errors. However,
it won't catch more succint issues such as style or grammar issues. As a
result, you should always inspect changes visually to ensure the result is
as intended.
The ``htmldocs-check`` target will fail if there are any syntax errors.
However, it won't catch more succint issues such as style or grammar issues.
As a result, you should always inspect changes visually to ensure the result
is as intended.

Once built, documentation is available in the ``/Documentation/_build`` folder.
Open the root ``index.html`` to browse the documentation.
Expand Down

0 comments on commit 1b996ac

Please sign in to comment.