sphinxer - GitHub Action

A GitHub Action to run Sphinx inside a Docker container

Usage

Example

Minimal:

uses: g5t/sphinxer@v1.0.0
with:
  pages_dir: pages

A more realistic case, including appropriate checkouts

steps:
- uses: actions/checkout@v2
  with:
    path: thisref

- uses: actions/checkout@v2
  with:
    ref: gh-pages
    path: pages
    fetch-depth: 0

- uses: actions/download-artifact@v2
  id: path
  with:
    name: ${{ needs.previous_job.outputs.artifact }}
    path: to

- id: wheelfact
  working-directory: to
  run: echo "::set-output name=wheel::to/$(ls)"

- uses: g5t/sphinxer@v2.0.2
  with:
    source_dir: thisref
    pages_dir: pages
    is_release: ${{ contains(github.event_name, 'release') }}
    create_readme: true
    wheel: ${{ steps.wheelfact.ouputs.wheel }}