Skip to content
build_sphinx_docs

fix(docs): correct IJEPA import path in docstring example (#407) #59

Sign in to view logs

fix(docs): correct IJEPA import path in docstring example (#407)

fix(docs): correct IJEPA import path in docstring example (#407) #59

Workflow file for this run

.github/workflows/docs.yml at 8f3c99c
name: build_sphinx_docs
on:
push:
branches:
- main
permissions:
contents: write
jobs:
build_docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[dev]"
- name: Generate .rst files from package
run: |
sphinx-apidoc -o docs/source stable_pretraining/
- name: Build Sphinx HTML documentation
run: |
cd docs
sphinx-build -b dirhtml source/ build/
- name: Upload documentation artifact
uses: actions/upload-artifact@v4
with:
name: sphinx-html
path: docs/build/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/