Skip to content

Commit

Permalink
Merge pull request #35 from Sindri-Labs/kp-fix-docs-build
Browse files Browse the repository at this point in the history
fix docs build again
  • Loading branch information
KPreisner authored Mar 18, 2024
2 parents 30b4301 + 3a2a138 commit 4b3bc9c
Show file tree
Hide file tree
Showing 5 changed files with 653 additions and 5 deletions.
9 changes: 7 additions & 2 deletions .github/workflows/generate-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,13 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: 3.10.6
- run: |
pip install requests>=2.13.0 lazydocs==0.4.8

- name: Install poetry
run: pip install poetry

- name: Install Dependencies
run: poetry install

- run: |
TAG=${{ github.ref_name }} ./build-docs.sh
Expand Down
5 changes: 4 additions & 1 deletion build-docs.sh
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
#!/usr/bin/env bash

# python3 -m venv venv
# source venv/bin/activate
# pip install poetry; poetry install

set -e

mkdir -p docs/docstrings

TAG="${TAG:-main}"

# pip install requests>=2.13.0 lazydocs==0.4.8
lazydocs \
--output-path="docs/docstrings" \
--overview-file="README.md" \
Expand Down
7 changes: 5 additions & 2 deletions local-run-docs.sh
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
#!/usr/bin/env bash

# python3 -m venv venv
# source venv/bin/activate
# pip install poetry; poetry install

set -e

mkdir -p docs/docstrings


TAG="${TAG:-main}"

# 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/sindri.py

# pip install mkdocs mkdocs-awesome-pages-plugin

echo "Hosting docs on http://localhost:1111"
mkdocs serve -a localhost:1111
Loading

0 comments on commit 4b3bc9c

Please sign in to comment.