Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sglvladi/sphinx-rtd-tutorial
A tutorial on how to use Sphinx
https://github.com/sglvladi/sphinx-rtd-tutorial
Last synced: 14 days ago
JSON representation
A tutorial on how to use Sphinx
- Host: GitHub
- URL: https://github.com/sglvladi/sphinx-rtd-tutorial
- Owner: sglvladi
- Created: 2018-03-10T09:27:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T08:44:49.000Z (7 months ago)
- Last Synced: 2024-10-03T12:39:45.579Z (about 1 month ago)
- Size: 1.57 MB
- Stars: 37
- Watchers: 2
- Forks: 107
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sphinx-RTD-Tutorial
A step-by-step tutorial on how to use Sphinx to turn your source code comments into a well presented documentation for your python packages an then publishing them to ReadTheDocs.org.Visit [Read the Docs](http://sphinx-rtd-tutorial.readthedocs.io) to read the full tutorial, or clone the repository and build it locally.