marten / github-sphinx-actions

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Github Actions for Sphinx documentation generator

This action will build the HTML version of your Sphinx documentation.

It can then be used with something like https://github.com/maxheld83/ghpages to deploy this to Github Pages.

Example usage

action "Build" {
    uses = "marten/github-sphinx-actions@master"
}

action "Only on master" {
    needs = "Build"
    uses = "actions/bin/filter@master"
    args = "branch master"
}

action "Deploy" {
    needs = "Only on master"
    uses = "maxheld83/ghpages@v0.2.1"
    env = {
        BUILD_DIR = "_build/html"
    }
    secrets = ["GH_PAT"]
}

About


Languages

Language:Dockerfile 73.9%Language:Shell 26.1%