https://github.com/rishabkumar7/sphinxy
https://github.com/rishabkumar7/sphinxy
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/rishabkumar7/sphinxy
- Owner: rishabkumar7
- License: mit
- Created: 2023-04-20T19:38:18.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-20T21:06:00.000Z (about 3 years ago)
- Last Synced: 2025-01-11T18:47:37.727Z (over 1 year ago)
- Language: Python
- Size: 656 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sphinxy
This is an example project to showcase how to use [Sphinx](https://www.sphinx-doc.org/en/master/) to generate documentation for a python API, and automate its deployment using GitHub Actions.
To get started, follow [this Sphinx tutorial](https://olgarithms.github.io/sphinx-tutorial/).