Skip to content

Merge pull request #241 from bact/revert-apidoc-permission #4

Merge pull request #241 from bact/revert-apidoc-permission

Merge pull request #241 from bact/revert-apidoc-permission #4

Workflow file for this run

# SPDX-FileCopyrightText: 2024 SPDX contributors
# SPDX-FileType: SOURCE
# SPDX-License-Identifier: Apache-2.0
name: Build and Deploy API Doc
on:
push:
branches:
- main
workflow_dispatch:
permissions:
contents: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up Python
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: "3.12"
- name: Install dependencies
run: |
pip install pip==25.0
pip install spdx-tools==0.8.3
pip install sphinx==8.1.3 sphinx-rtd-theme==3.0.2
- name: Build documentation
run: |
sphinx-apidoc -o docs/ ntia_conformance_checker/
cd docs
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html