Skip to content

Commit

Permalink
cli: author-mode: Fix make clean and touch source
Browse files Browse the repository at this point in the history
Good side-effect: will also trigger a full rebuild.

Signed-off-by: Jorge Marques <[email protected]>
  • Loading branch information
gastmaier committed Dec 1, 2024
1 parent c6b38ea commit 160113d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 4 additions & 0 deletions adi_doctools/cli/author_mode.py
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,10 @@ def check_files(scheduler):
update_page = True
watch_file_src[file] = ctime

if not path.isdir(builddir):
# User did make clean
update_sphinx = True

if first_run is True:
first_run = False
update_page = False
Expand Down
6 changes: 1 addition & 5 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,7 @@ 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, for example:

.. shell::

$make clean ; touch conf.rst
Run ``make clean`` in another tab, it will trigger a full rebuild.

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.
Expand Down

0 comments on commit 160113d

Please sign in to comment.