https://github.com/eeholmes/readthedoc-test
https://github.com/eeholmes/readthedoc-test
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/eeholmes/readthedoc-test
- Owner: eeholmes
- Created: 2022-03-30T03:54:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T16:12:45.000Z (almost 3 years ago)
- Last Synced: 2025-03-22T08:23:28.339Z (over 1 year ago)
- Language: Python
- Homepage: https://eeholmes.github.io/readthedoc-test
- Size: 2.79 MB
- Stars: 9
- Watchers: 1
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Template for the Read the Docs tutorial
=======================================
Automatic documentation generation using [Sphinx-docs](https://www.sphinx-doc.org/en/master/). I happen to be using a Readthedocs theme but there are many you can use. See the Sphinx documentation.
My repo has a GitHub Action set up to build the documentation on any push to the main branch. My repo is modeled off: https://github.com/maltfield/rtd-github-pages
Reference for simple Sphinx with sphinx-apidoc https://shunsvineyard.info/2019/09/19/use-sphinx-for-python-documentation
Using this auto generation: https://sphinx-autoapi.readthedocs.io/en/latest/index.html
```
pip install sphinx-autoapi
```