doc: Update makefile target for docs
@@ -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.
