Merge pull request #734 from michaeljones/fix-sys-path

Fix sys.path adjustment in doc config
breathe-doc · Sep 21, 2021 · 436c4f7 · 436c4f7
2 parents 943534f + 287113f
commit 436c4f7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -24,7 +24,7 @@ jobs:
 
       - name: build the documentation
         run: |
-          PYTHONPATH="${PWD}${PYTHONPATH:+:$PYTHONPATH}" make html
+          make html
           rm documentation/build/html/.buildinfo
 
       - uses: actions/upload-artifact@v1

diff --git a/documentation/source/conf.py b/documentation/source/conf.py
@@ -78,8 +78,9 @@
 
 else:
 
-    # For our usual dev build we'll be in the 'documentation' directory
-    sys.path.append('../')
+    # For our usual dev build we'll be in the 'documentation' directory but Sphinx seems to set the
+    # current working directory to 'source' so we append relative to that
+    sys.path.append('../../')
 
     # Check if it matches a pure tag number vX.Y.Z, rather than vX.Y.Z-91-g8676988 which is how
     # non-tagged commits are described (ie. relative to the last tag)