Welcome to Sphinx-Pages-Template!
This is a template for creating Sphinx webpages hosted on Github Pages. This template has been used to host:
- Itself
- CAMS CSC CIS-Breakdown
- FRC Team 687 (The Nerd Herd) Documentation
- Jonathan Virak's CSA Course
First, press "Use this template" to create your own copy of this template repository. Then, in your fork, change ORGANIZATION_NAME in /.github/workflows/sphinx-build.yaml to your Github username, and change branches to contain your branch's name. Then, modify /source/conf.py to contain the proper author, copyright, and website name.
Then, edit the markdown files in /source to modify your website. When changes are committed, the website pages should autobuild into /docs.
To add additional pages or change the layout of the sidebar, change /source/index.rst to match your layout.
To change the Sphinx theme, edit the variable html_theme in /source/conf.py to your theme's name, and add the name of the theme to requirements.txt. For a list of Sphinx themes, see this page.
In your repository settings (found at the top of the github page), find the Pages tab in the bottom left. Then, set "Source" to "Deploy from a branch," select a branch, and set the directory to /docs. After pushing a new commit, the page should update.