You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 lines
940 B
42 lines
940 B
name: OctoDNS Documentation
|
|
|
|
on:
|
|
push:
|
|
tags:
|
|
- "v*.*.*"
|
|
|
|
pull_request:
|
|
branches: [main, master]
|
|
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
build-docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Setup python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.12"
|
|
|
|
- name: Install requirements-dev
|
|
run: pip install -r requirements-dev.txt
|
|
|
|
- name: Run scripts/get-docs
|
|
run: ./script/get-docs
|
|
|
|
- name: Build Sphinx
|
|
uses: ammaraskar/sphinx-action@8.2.3
|
|
with:
|
|
docs-folder: "docs/"
|
|
build-command: "sphinx-build -b html . _build"
|
|
|
|
- name: Deploy to gh-pages branch
|
|
uses: peaceiris/actions-gh-pages@v4
|
|
if: github.event_name != 'pull_request'
|
|
with:
|
|
publish_dir: docs/_build/html
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|