ardvansomeren / avs1416-repository-template

Template for a new repository using Read the Docs
https://docs.readthedocs.io/en/stable/tutorial/
0 stars 0 forks source link
readthedocs template

GitHub template for a new repository using Read the Docs

Orginaly setup from Graziella, making use of some Python examples, .rst and .toml files.

.rst: https://g.co/kgs/TJ6fbQ .toml: https://g.co/kgs/ajqeRt

This GitHub template includes some basic Sphinx docs. Sphinx: https://g.co/kgs/h9ZL2a

The primary goal is to investigate how to create a GitHub template repository that will setup a docs structure when a new repository is created.

I leave the use of these files intact to start with, but will probably change some of them to for example MarkDown MD: https://www.markdownguide.org/

Read the tutorial for Read the Docs here: RTD: https://docs.readthedocs.io/en/stable/tutorial/