As GitHub documentation says, “GitHub Pages is a static site hosting service that takes files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website”.
Before you publish your documentation on GitHub Pages, make sure your documentation files are in the zen/_build/html directory of your repository, like this:
If you created your repository from the demo repository template, all the required files are already in the zen/_build/html directory.
To publish files from this directory on GitHub Pages:
Open your repository settings.
Select Pages.
In the Build and deployment section, under Source, select GitHub Actions.
In Static HTML, click Configure.
GitHub creates a .github/workflows/static.yml file for you.
In static.yml file, find the path element, it should look like this:
# Upload entire repositorypath:'.'
Change the path as follows:
# Upload _build/htmlpath:'./zen/_build/html'
Click Start commit, and then Commit new file.
Once static.yml is committed, GitHub immediately starts publishing your documentation site. The publishing process may take some time, and when it is finished, you can open your documentation by clicking Visit site on Settings -> Pages:
