[LTP] [PATCH 1/1] doc/documentation: Add tip for debugging .readthedocs.yml

Petr Vorel pvorel@suse.cz
Fri Feb 7 13:48:30 CET 2025


Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/developers/documentation.rst | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst
index 27c847e125..2308010006 100644
--- a/doc/developers/documentation.rst
+++ b/doc/developers/documentation.rst
@@ -18,9 +18,9 @@ Before building, make sure you have python3 ``virtualenv`` module installed.
     # run configure to be able to compile doc dependencies in metadata/
     make autotools
     ./configure
-    cd doc
 
     # prepare virtual environment
+    cd doc
     python3 -m virtualenv .venv
     . .venv/bin/activate
 
@@ -39,6 +39,14 @@ Once the procedure has been completed, documentation will be visible at
     older Python versions were causing issues. No other version has been tested,
     but it should work anyway.
 
+.. tip::
+
+    For debugging :master:`.readthedocs.yml` (can't be debugged locally) it's
+    the least intrusive to set in `ReadTheDoc settings
+    <https://app.readthedocs.org/dashboard/linux-test-project/edit/>`_
+    different *default branch*. This allows to use ``git push -f`` without
+    polluting master branch.
+
 Validating spelling
 ~~~~~~~~~~~~~~~~~~~
 
-- 
2.47.2



More information about the ltp mailing list