[Lldb-commits] [lldb] [LLDB] Update docs on building documentation (PR #69858)

[Aiden Grossman via lldb-commits]

https://github.com/boomanaiden154 updated https://github.com/llvm/llvm-project/pull/69858

>From b7ff618fe56ab8ba8cb40c5f69a06a805f4e6e62 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 15:46:39 -0700
Subject: [PATCH 1/4] [LLDB] Update docs on building documentation

This patch updates the documentation to match recent changes and make it more
clear. More specifically, the process for installing sphinx has changed with
the transition to myst with the requirements.txt in llvm/docs being the
preferred method for installation now. In addition, the docs-lldb-html target
is never generated if swig isn't installed, so having something expliti in
the documentation section (even if it is mentioned as a dependency of lldb
itself above) probably doesn't hurt.
---
 lldb/docs/resources/build.rst | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index b405a20e239912c..ae3a8ccccce4a25 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -403,13 +403,21 @@ dependencies are required:
 * Sphinx (for the website and the Python API reference)
 * Graphviz (for the 'dot' tool)
 * doxygen (if you wish to build the C++ API reference)
+* Swig (for generating Python bindings)
 
-To install the prerequisites for building the documentation (on Debian/Ubuntu)
+To install the system prerequisites for building the documentation (on Debian/Ubuntu)
 do:
 
 ::
 
-  $ sudo apt-get install doxygen graphviz python3-sphinx
+  $ sudo apt-get install doxygen graphviz swig
+
+To install Sphinx and its dependencies, use the ``requirements.txt`` available within LLVM
+to ensure you get a working configuration:
+
+::
+
+  $ pip3 install -r /path/to/llvm-project/llvm/docs/requirements.txt
 
 To build the documentation, configure with ``LLVM_ENABLE_SPHINX=ON`` and build the desired target(s).
 

>From e2eea3a4414865c9db74157f3b0ade173dc02362 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 15:57:42 -0700
Subject: [PATCH 2/4] Test if this makes the CI faster

---
 .github/workflows/docs.yml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 24e1c9c7de8ee90..6525827ba403328 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -32,11 +32,14 @@ jobs:
       # Fetch all the commits in a pull request so that the
       # docs-changed-subprojects step won't pull them in itself in an extremely
       # slow manner.
+      - name: 'PR commits + 1'
+        if: ${{ github.event_name == 'pull_request' }}
+        run: echo "PR_FETCH_DEPTH=$(( ${{ github.event.pull_request.commits }} + 1 ))" >> "${GITHUB_ENV}"
       - name: Fetch LLVM sources (PR)
         if: ${{ github.event_name == 'pull_request' }} 
         uses: actions/checkout at v4
         with:
-          fetch-depth: ${{ github.event.pull_request.commits }}
+          fetch-depth: ${{ env.PR_FETCH_DPETH }}
       - name: Fetch LLVM sources (push)
         if: ${{ github.event_name == 'push' }}
         uses: actions/checkout at v4

>From d04a2569ff8895a53c7e32b7da6edd934b90bd0b Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 15:59:02 -0700
Subject: [PATCH 3/4] Fix typo

---
 .github/workflows/docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 6525827ba403328..6e6b98c3022f07e 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -39,7 +39,7 @@ jobs:
         if: ${{ github.event_name == 'pull_request' }} 
         uses: actions/checkout at v4
         with:
-          fetch-depth: ${{ env.PR_FETCH_DPETH }}
+          fetch-depth: ${{ env.PR_FETCH_DEPTH }}
       - name: Fetch LLVM sources (push)
         if: ${{ github.event_name == 'push' }}
         uses: actions/checkout at v4

>From 633e63f98df5a5dd2b9749bf39c857313f578567 Mon Sep 17 00:00:00 2001
From: Aiden Grossman <agrossman154 at yahoo.com>
Date: Sat, 21 Oct 2023 16:04:53 -0700
Subject: [PATCH 4/4] Try removing fix to see if problem returns

---
 .github/workflows/docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 6e6b98c3022f07e..d5dc3bfa24fa3a4 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -39,7 +39,7 @@ jobs:
         if: ${{ github.event_name == 'pull_request' }} 
         uses: actions/checkout at v4
         with:
-          fetch-depth: ${{ env.PR_FETCH_DEPTH }}
+          fetch-depth: ${{ github.event.pull_request.commits }}
       - name: Fetch LLVM sources (push)
         if: ${{ github.event_name == 'push' }}
         uses: actions/checkout at v4