jlin27 / pydocsite

Sample application demonstrating documentation added to a Python project.

Python Documentation Site Example

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.

Testing this project

To test this project in your own repo, follow these steps:

1. Fork this repo.
2. Turn GitHub Pages on in Settings
3. Enable the GitHub Actions workflow
4. Customize your site in website
5. 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.