Merge pull request #253 from bact/add-faq-online-tools #12

	# 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: read

	jobs:
	build-docs:
	runs-on: ubuntu-latest
	permissions:
	contents: write

	steps:
	- name: Checkout repository
	uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

	- name: Set up Python
	uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
	with:
	python-version: "3.12"

	- name: Install dependencies
	run: \|
	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

Provide feedback