diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2023-06-30 18:07:02 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2023-07-01 22:45:19 +0200 |
| commit | 5720844fcdc8601798e10544e2fd25ce4f2ad099 (patch) | |
| tree | af611e4aef436253f4fda9504d06e05e2621114d /docs/dev/makefile.rst | |
| parent | 8e8d8dabe9b17c9db8db7432c6bc063d9ae980d1 (diff) | |
[doc] rearranges Settings & Engines docs for better readability
We have built up detailed documentation of the *settings* and the *engines* over
the past few years. However, this documentation was still spread over various
chapters and was difficult to navigate in its entirety.
This patch rearranges the Settings & Engines documentation for better
readability.
To review new ordered docs::
make docs.clean docs.live
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/makefile.rst')
| -rw-r--r-- | docs/dev/makefile.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index bdf7f0f49..ad5665de7 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -22,7 +22,7 @@ Calling the ``help`` target gives a first overview (``make help``): .. program-output:: bash -c "cd ..; make --no-print-directory help" -.. contents:: Contents +.. contents:: :depth: 2 :local: :backlinks: entry @@ -243,14 +243,14 @@ calling ``make clean`` stop all processes using the :ref:`make install` or We describe the usage of the ``doc.*`` targets in the :ref:`How to contribute / Documentation <contrib docs>` section. If you want to edit the documentation read our :ref:`make docs.live` section. If you are working in your own brand, -adjust your :ref:`settings global`. +adjust your :ref:`settings brand`. .. _make docs.gh-pages: ``make docs.gh-pages`` ====================== -To deploy on github.io first adjust your :ref:`settings global`. For any +To deploy on github.io first adjust your :ref:`settings brand`. For any further read :ref:`deploy on github.io`. .. _make test: |