@@ -93,7 +93,7 @@ The documentation is built using Sphinx_. So in order to be able to generate
93the required files, you have to install it on your system. Much easier, use
93the required files, you have to install it on your system. Much easier, use
94Makefile our targets.
94Makefile our targets.
96−Here is an example which makes complete rebuild:
96+Here is an example which makes a complete rebuild:
98.. code:: sh
98.. code:: sh
@@ -105,13 +105,18 @@ Here is an example which makes complete rebuild:
105live build
105live build
106----------
106----------
108+.. sidebar:: docs-clean
110+ It is recommended to assert a complete rebuild before deploying (use
108Live build is like WYSIWYG, If you want to edit the documentation, its
113Live build is like WYSIWYG, If you want to edit the documentation, its
109recommended to use. The Makefile target ``docs-live`` builds the docs, opens URL
114recommended to use. The Makefile target ``docs-live`` builds the docs, opens URL
110in your favorite browser and rebuilds every time a reST file has been changed.
115in your favorite browser and rebuilds every time a reST file has been changed.
112.. code:: sh
117.. code:: sh
114− $ make docs-clean docs-clean
119+ $ make docs-live
116 The HTML pages are in dist/docs.
121 The HTML pages are in dist/docs.
117 ... Serving on http://0.0.0.0:8080
122 ... Serving on http://0.0.0.0:8080
@@ -129,7 +134,7 @@ needed git add, commit and push:
130.. code:: sh
135.. code:: sh
132− $ make gh-pages
137+ $ make docs-clean gh-pages
134 SPHINX docs --> file://<...>/dist/docs
139 SPHINX docs --> file://<...>/dist/docs
135 The HTML pages are in dist/docs.
140 The HTML pages are in dist/docs.