Second attempt to fix doc generation errors in CI

ethz-asl · Aug 16, 2024 · d7c61f5 · d7c61f5
1 parent 35d7566
commit d7c61f5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -136,18 +136,18 @@ jobs:
     container:
       image: ${{ needs.build-image.outputs.image }}
     steps:
-      - name: Fetch the package's repository
-        uses: actions/checkout@v4
-
       - name: Install dependencies (doxygen+sphinx+breathe+exhale toolchain)
         run: |
           apt-get update
-          apt-get install -q -y --no-install-recommends python3-pip doxygen
+          apt-get install -q -y --no-install-recommends python3-pip doxygen git
           apt-get install -q -y --no-install-recommends latexmk texlive-latex-extra tex-gyre texlive-fonts-recommended texlive-latex-recommended
           pip3 install exhale sphinx-sitemap sphinx-design gitpython
           pip3 install sphinxawesome-theme --pre
           pip3 install "sphinx<7,>6"
 
+      - name: Fetch the package's repository
+        uses: actions/checkout@v4
+
       - name: Parse C++ library with Doxygen
         working-directory: ${{ env.CATKIN_WS_PATH }}/src/${{ env.REPOSITORY_NAME }}/docs
         shell: bash

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -142,18 +142,18 @@ jobs:
     container:
       image: ${{ needs.workspace-container.outputs.image }}
     steps:
-      - name: Fetch the package's repository
-        uses: actions/checkout@v4
-
       - name: Install dependencies (doxygen+sphinx+breathe+exhale toolchain)
         run: |
           apt-get update
-          apt-get install -q -y --no-install-recommends python3-pip doxygen
+          apt-get install -q -y --no-install-recommends python3-pip doxygen git
           apt-get install -q -y --no-install-recommends latexmk texlive-latex-extra tex-gyre texlive-fonts-recommended texlive-latex-recommended
           pip3 install exhale sphinx-sitemap sphinx-design gitpython
           pip3 install sphinxawesome-theme --pre
           pip3 install "sphinx<7,>6"
 
+      - name: Fetch the package's repository
+        uses: actions/checkout@v4
+
       - name: Parse C++ library with Doxygen
         working-directory: ${{ env.CATKIN_WS_PATH }}/src/${{ env.REPOSITORY_NAME }}/docs
         shell: bash

diff --git a/docs/conf.py b/docs/conf.py
@@ -128,7 +128,8 @@
 highlight_language = 'cpp'
 
 # Provide a short syntax to link to files in the repository
-repo = git.Repo(os.path.abspath(__file__), search_parent_directories=True)
+repo_path = os.path.abspath(os.path.join(__file__, *[os.pardir] * 2))
+repo = git.Repo(repo_path)
 sha = repo.head.object.hexsha
 extlinks = {
     "gh_file": (f"https://github.com/ethz-asl/wavemap/tree/{sha}/%s", "%s"),