Skip to content

Docs: Added documentation for property normalization features. #17

Docs: Added documentation for property normalization features.

Docs: Added documentation for property normalization features. #17

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main # or your default branch
paths:
- "docs/**"
- ".github/workflows/docs.yml"
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: "pip"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements-torch.txt
pip install -r docs/requirements.txt
pip install --no-deps -e .
- name: Build documentation
run: |
cd docs
# Create _static directory
mkdir -p _static
# Create _autosummary directory
mkdir -p _autosummary
make html
# Create .nojekyll file to allow files and folders starting with an underscore
touch _build/html/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/_build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
if: github.ref == 'refs/heads/main' # only deploy from main branch
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2