1. Introduction

These docs provide a simple instruction list for setting up automatic updating of your project documentation hosted at ReadTheDocs.

Overall Process

Python -> Sphinx -> VSCode -> reStructuredText -> GitHub -> ReadTheDocs

1. Using Python, set up Sphinx to translate the .rst files into HTML (and PDF) file formats.

2. In VSCode, create plain text source files in reStructuredText (.rst) format.

3. In VSCode, push the documentation changes to a GitHub repository.

4. Set up ReadTheDocs to automatically update via a webhook to GitHub.

---

1.1. Required software

1. Python

2. Sphinx

3. Sphinx theme for read the docs

4. Sphinx extensions

5. Visual Studio code (VSCode)

6. Visual Studio code reStructuredText (reST) extension

7. Git command line tool

8. Github (free account)

9. ReadTheDocs (RTD) (free account)