Minor doc update, bump version

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
analogdevicesinc · Oct 1, 2024 · 39901e9 · 39901e9
1 parent 8d4347f
commit 39901e9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/adi_doctools/__init__.py b/adi_doctools/__init__.py
@@ -12,7 +12,7 @@
 from .lut import get_lut
 from .role.interref import interref_repos_apply
 
-__version__ = "0.3.45"
+__version__ = "0.3.46"
 
 logger = logging.getLogger(__name__)
 

diff --git a/docs/cli.rst b/docs/cli.rst
@@ -50,7 +50,11 @@ All options can be listed with:
 How can I rebuild the whole documentation within Author Mode?
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-Run ``make clean`` in another tab and then touch any file.
+Run ``make clean`` in another tab and then touch any file, for example:
+
+::
+
+   make clean ; touch conf.rst
 
 Do **not** do ``make clean html`` since it will generate a build without the
 proper Author Mode environment and live reload won't work properly.

diff --git a/docs/docs_guidelines.rst b/docs/docs_guidelines.rst
@@ -641,7 +641,7 @@ That means, each line is prefixed by character to:
 
 Anything that does not match the previous characters will default to output print,
 but please be careful, since you may accidentally mark a working directory or
-command, if not denting the output by one space.
+command, if not identing the output by one space.
 
 The bash type defaults to ``bash``, user to ``user``, group to ``analog``
 and the working directory as "doesn't matter" (hidden), so, for