test-sphinx

An example to deploy sphinx website to GitHub Pages with the GitHub Pages Action.

Clone and Build

git clone https://github.com/peaceiris/test-sphinx.git
cd test-sphinx
pipenv sync --dev
pipenv run make html

The project was generated as follows.

pipenv install --dev sphinx
pipenv run sphinx-quickstart

Custom Domain

CNAME file will be generated by the html_baseurl.

cf. sphinx.ext.githubpages – Publish HTML docs in GitHub Pages — Sphinx documentation