https://github.com/vanheemstrasystems/read-the-docs
Read The Docs
https://github.com/vanheemstrasystems/read-the-docs
Last synced: 12 months ago
JSON representation
Read The Docs
- Host: GitHub
- URL: https://github.com/vanheemstrasystems/read-the-docs
- Owner: vanHeemstraSystems
- Created: 2023-07-21T10:32:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-21T13:37:10.000Z (almost 3 years ago)
- Last Synced: 2025-03-25T14:16:43.686Z (over 1 year ago)
- Language: Python
- Size: 23.8 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://readthedocs-headstart.readthedocs.io/en/latest/?badge=latest)
read-the-docs
# Read The Docs
Create, host, and browse documentation.
Based on "Read The Docs" at https://readthedocs.org
**WARNING**: See Sphinx build failing on act but succeeding on actions at https://github.com/nektos/act/issues/1853
Do the following:
```
$ date
Wed Jul 16 22:52:47 EDT 2014
$ cat /etc/timezone
America/New_York
$ sudo dpkg-reconfigure tzdata
$ service cron stop && service cron start
```
You will be prompted to saet your timezone.
## 000 - Installation
Follow this tutorial: https://www.sphinx-doc.org/en/master/tutorial/getting-started.html
## 100 - Introduction
See [README.md](./100/README.md)
## 200 - Tutorial
See [README.md](./200/README.md)
## 300 - Customization
Follow this tutorial: https://www.sphinx-doc.org/en/master/tutorial/first-steps.html
## 400 - Build
Follow the instructions: https://readthedocs.org/projects/readthedocs-headstart/