Skip to content

Commit

Permalink
create and deploy Sphinx documentation for lib
Browse files Browse the repository at this point in the history
The config file is largely based on GitHub's own examples:
https://github.com/actions/deploy-pages

Signed-off-by: Jiri Jaburek <[email protected]>
  • Loading branch information
comps authored and mildas committed Feb 15, 2024
1 parent dfc0e18 commit 4496508
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Deploy documentation to GH Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Make test html page
run: |
python3 -m pip install sphinx sphinx-rtd-theme sphinx-autoapi
sphinx-quickstart -p Contest -a Fantomas -v 1 -r 1 -l en --sep \
--extensions sphinx.ext.githubpages,sphinx.ext.autodoc,autoapi.extension .
sed '/^html_theme = /s/.*/html_theme = "sphinx_rtd_theme"/' -i source/conf.py
sed '1i autoapi_dirs = ["../lib"]' -i source/conf.py
sed '1i autoapi_options = ["members", "undoc-members", "show-inheritance"]' -i source/conf.py
sphinx-build source build
mv build _site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ These have some unfortunate metadata, such as

which are removed by `translate_ssg_kickstart()` [in virt.py](lib/virt.py).

## Referencing library code

See https://rhsecuritycompliance.github.io/contest/ for online Sphinx version
of the modules present in `lib`.

## Debugging

(TODO: probably move to its own document?)
Expand Down

0 comments on commit 4496508

Please sign in to comment.