Skip to content

Commit

Permalink
First attempt at publishing docs to github
Browse files Browse the repository at this point in the history
  • Loading branch information
gphipps authored and gphipps committed Jul 25, 2024
1 parent 82c341b commit eb2b608
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: deploy

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: python -m pip install .[docs] --upgrade pip
- name: Generate API docs & Build sphinx documentation
run: |
git fetch --tags
cd docs
python build.py
cd ..
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/pages'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions src/onemod/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from onemod.scheduler.scheduler import Scheduler
from onemod.utils import format_input, get_handle


def run_pipeline(
directory: str,
stages: list[str] | None = None,
Expand Down

0 comments on commit eb2b608

Please sign in to comment.