This example was developed to demonstrate how Docusaurus, Sphinx, and GitHub actions can be used to easily add a website landing to a project.
This project is based on Ken Reitz's excellent Python starting project: Learn more.
If you want to learn more about setup.py files, check out this repository.
We added Sphinx and Docusaurus 2 for documentation.
To test this project in your own repo, follow these steps:
- Fork this repo.
- Turn GitHub Pages on in Settings
- Enable the GitHub Actions workflow
- Customize your site in website
- Customize the API content in /sphinx and source
Changes should trigger a rebuild.
Your site should be available at https://<accountname>.github.io/pydocsite.
The GitHub action uses James Ives GitHub Deploy Action.