on master help sign in
doc: add note about docs-clean target

BTW: fix some typos Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

commitfcd7f4cd1205db48c8796a1ba12bcb1d358a554e authorMarkus Heiser <markus.heiser@darmarit.de> dateFri 13 Dec 2019, 15:22 (7 years ago) parente4e578e
1 file changed+8−3
docs/dev/contribution_guide.rst+8−3
docs/dev/contribution_guide.rst+8−3
@@ -93,7 +93,7 @@ The documentation is built using Sphinx_. So in order to be able to generate
9393the required files, you have to install it on your system. Much easier, use
9494Makefile our targets.
9595
96−Here is an example which makes complete rebuild:
96+Here is an example which makes a complete rebuild:
9797
9898.. code:: sh
9999
@@ -105,13 +105,18 @@ Here is an example which makes complete rebuild:
105105live build
106106----------
107107
108+.. sidebar:: docs-clean
109+
110+ It is recommended to assert a complete rebuild before deploying (use
111+ ``docs-clean``).
112+
108113Live build is like WYSIWYG, If you want to edit the documentation, its
109114recommended to use. The Makefile target ``docs-live`` builds the docs, opens URL
110115in your favorite browser and rebuilds every time a reST file has been changed.
111116
112117.. code:: sh
113118
114− $ make docs-clean docs-clean
119+ $ make docs-live
115120 ...
116121 The HTML pages are in dist/docs.
117122 ... Serving on http://0.0.0.0:8080
@@ -129,7 +134,7 @@ needed git add, commit and push:
129134
130135.. code:: sh
131136
132− $ make gh-pages
137+ $ make docs-clean gh-pages
133138 ...
134139 SPHINX docs --> file://<...>/dist/docs
135140 The HTML pages are in dist/docs.