summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2019-12-13 15:22:10 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2019-12-13 15:22:10 +0100
commitfcd7f4cd1205db48c8796a1ba12bcb1d358a554e (patch)
tree11214c79582b46a909db22ac8f0cf06c9e533de8
parente4e578e8a972ff7d7d224c30f2a109d2b5438ea1 (diff)
doc: add note about docs-clean target
BTW: fix some typos Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
-rw-r--r--docs/dev/contribution_guide.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/dev/contribution_guide.rst b/docs/dev/contribution_guide.rst
index 22d690033..064f28e63 100644
--- a/docs/dev/contribution_guide.rst
+++ b/docs/dev/contribution_guide.rst
@@ -93,7 +93,7 @@ The documentation is built using Sphinx_. So in order to be able to generate
the required files, you have to install it on your system. Much easier, use
Makefile our targets.
-Here is an example which makes complete rebuild:
+Here is an example which makes a complete rebuild:
.. code:: sh
@@ -105,13 +105,18 @@ Here is an example which makes complete rebuild:
live build
----------
+.. sidebar:: docs-clean
+
+ It is recommended to assert a complete rebuild before deploying (use
+ ``docs-clean``).
+
Live build is like WYSIWYG, If you want to edit the documentation, its
recommended to use. The Makefile target ``docs-live`` builds the docs, opens URL
in your favorite browser and rebuilds every time a reST file has been changed.
.. code:: sh
- $ make docs-clean docs-clean
+ $ make docs-live
...
The HTML pages are in dist/docs.
... Serving on http://0.0.0.0:8080
@@ -129,7 +134,7 @@ needed git add, commit and push:
.. code:: sh
- $ make gh-pages
+ $ make docs-clean gh-pages
...
SPHINX docs --> file://<...>/dist/docs
The HTML pages are in dist/docs.