Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

Auto Sphinx Page

v1

Auto Sphinx Page

play

Auto Sphinx Page

Creates website from repo using Sphinx

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Auto Sphinx Page

              
  uses: yuanx749/auto-sphinx-page-action@v1
Learn more about this action in yuanx749/auto-sphinx-page-action

Choose a version

auto-sphinx-page-action

GitHub action that creates website using Sphinx.

This action creates a website from your repository, by building with Sphinx.

Features

  • Set up the configuration of Sphinx automatically.
  • Use README as the homepage if index does not exist at the root level.
  • Use PyData theme.
  • Support MyST Markdown. For more information, see MyST-Parser.
  • Publish to GitHub Pages.

Usage

Refer to the GitHub docs to enable publishing to GitHub Pages.

Set up a workflow in Actions. An example .yml file is as below.

on:
  workflow_dispatch:
  push:
    branches:
      - main
      - master

jobs:
  build-deploy:
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - id: deployment
        uses: yuanx749/auto-sphinx-page-action@main
        with:
          project: "project"  # project's name, optional, default repository name
          author: "author"  # author name, optional, default username

Or use a reusable workflow:

on:
  workflow_dispatch:
  push:

jobs:
  build-deploy:
    permissions:
      pages: write
      id-token: write
    uses: yuanx749/auto-sphinx-page-action/.github/workflows/main.yml@main