TheProjectsGuy/rtd-rst-tutorial

A tutorial (and reference documentation) on ReadtheDocs and reStructuredText at one place (with all links)

ReadtheDocs - reStructuredText Tutorials

Tutorials concerning ReadtheDocs and reStructuredText.

Note: This is a sort of reST documentation and reference for my personal reference. I also created this as a ReadTheDocs reference.

Only this document is written in Markdown, all other documentation in this repository is written in reST (reStructuredText).

Table of contents

• ReadtheDocs - reStructuredText Tutorials
  • Table of contents
  • Tutorials
    • Initial Setup
  • Contents
  • References
    • reST

Tutorials

Initial Setup

Initial setup was done using initial_setup.rst.

Contents

The contents of this folder are described below

S. No.	File	Description
1	initial_setup.rst	Setting up everything

References

• ReadtheDocs: Website | Docs
• reStructuredText: Website
• Sphinx: https://www.sphinx-doc.org/en/master/
• VSCode extensions
  • reStructuredText
    • lextudio.restructuredtext
    • trond-snekvik.simple-rst

reST

• Official quick reference: https://docutils.sourceforge.io/docs/user/rst/quickref.html
• reStructuredText Primer on sphinx: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html