Merge pull request #34 from Sindri-Labs/kp-fix-docs-build

Fix docs build
Sindri-Labs · Mar 18, 2024 · 30b4301 · 30b4301
2 parents dcb7147 + a790c9c
commit 30b4301
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-docs.yml
@@ -17,7 +17,7 @@ jobs:
         with:
           python-version: 3.10.6
       - run: |
-          pip install requests>=2.13.0 lazydocs
+          pip install requests>=2.13.0 lazydocs==0.4.8
       - run: |
           TAG=${{ github.ref_name }} ./build-docs.sh
 

diff --git a/build-docs.sh b/build-docs.sh
@@ -1,12 +1,15 @@
 #!/usr/bin/env bash
+
+set -e
+
 mkdir -p docs/docstrings
 
 TAG="${TAG:-main}"
 
-# pip install requests>=2.13.0 lazydocs
+# pip install requests>=2.13.0 lazydocs==0.4.8
 lazydocs \
     --output-path="docs/docstrings" \
     --overview-file="README.md" \
     --src-base-url="https://github.com/Sindri-Labs/sindri-python/blob/$TAG/" \
     --no-watermark \
-    src/sindri
+    src/sindri/sindri.py
diff --git a/local-run-docs.sh b/local-run-docs.sh
@@ -1,16 +1,19 @@
 #!/usr/bin/env bash
+
+set -e
+
 mkdir -p docs/docstrings
 
 
 TAG="${TAG:-main}"
 
-# pip install requests>=2.13.0 lazydocs
+# pip install requests>=2.13.0 lazydocs==0.4.8
 lazydocs \
     --output-path="./docs/docstrings" \
     --overview-file="README.md" \
     --src-base-url="https://github.com/Sindri-Labs/sindri-python/blob/$TAG/" \
     --no-watermark \
-    src/sindri
+    src/sindri/sindri.py
 
 # pip install mkdocs mkdocs-awesome-pages-plugin
 echo "Hosting docs on http://localhost:1111"