README.rst

Sphinx to GitHub Pages V3

Help you deploying your Sphinx documentation to Github Pages.

Usage

1. Set the publishing sources to "Github Actions"

   Note

   Publishing your GitHub Pages site with a custom GitHub Actions workflow is in beta and subject to change.

2. Create workflow:

   name: Deploy Sphinx documentation to Pages
   
   # Runs on pushes targeting the default branch
   on:
     push:
       branches: [master]
   
   # Allow one concurrent deployment
   concurrency:
     group: "pages"
     cancel-in-progress: true
   
   jobs:
     pages:
       runs-on: ubuntu-20.04
       environment:
         name: github-pages
         url: ${{ steps.deployment.outputs.page_url }}
       permissions:
         pages: write
         id-token: write
       steps:
       - id: deployment
         uses: sphinx-notes/pages@v3

Inputs

Outputs

Output	Description
page_url	URL to deployed GitHub Pages

Examples

The following repository's pages are built by this action:

• https://github.com/SilverRainZ/bullet
• https://github.com/sphinx-notes/pages
• https://github.com/sphinx-notes/any
• https://github.com/sphinx-notes/snippet
• https://github.com/sphinx-notes/lilypond
• https://github.com/sphinx-notes/strike
• ...

You can found the workflow file in their repository.

Tips

Copy extra files to site

Use Sphinx confval html_extra_path.