Skip to content

another typo

another typo #10

Workflow file for this run

# name: Build and Deploy orgroamtools Docs
# on: [push]
# permissions:
# contents: write
# jobs:
# docs:
# name: Publish documentation
# runs-on: ubuntu-latest
# steps:
# - name: Checkout Repository
# uses: actions/checkout@v3
# - name: Set Up Python
# uses: actions/setup-python@v3
# with:
# python-version: 3.7 # Specify your Python version
# - name: Install Dependencies
# run: |
# python -m pip install --upgrade pip
# pip install -r docs/requirements.txt
# - name: Build Docs with Sphinx
# run: |
# cd docs
# sphinx-apidoc -o source/ ../orgroamtools
# sphinx-build docs build
# make html
# - name: Deploy to GitHub Pages
# uses: peaceiris/actions-gh-pages@v3
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_branch: gh-pages
# publish_dir: docs/build/html
#
name: Publish documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
python3 -m pip install docs/requirements.txt
- name: Sphinx build
run: |
cd docs
sphinx-build docs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/
force_orphan: true