Skip to content

update docs

update docs #9

Workflow file for this run

name: Docs
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install documentation dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
pip install -e .
#- name: Import check
# run: python -c "import omd2tex"
- name: Clean build directory
run: rm -rf docs/_build/html
- name: Build HTML
run: sphinx-build -b html docs/source docs/_build/html
- name: Disable Jekyll
run: touch docs/_build/html/.nojekyll
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
publish_branch: gh-pages
force_orphan: true