Create Documentation with RST, Sphinx, Sublime, and GitHub

This project captures guidelines and tips for efficiently creating documentation using RST, Sphinx, Sublime Text, and GitHub.

This project is also created using the guidelines it describes.

This document is geared towards content creators, not programmers.

Contributions are welcome in the GitHub Repository.

Get Started

• Set Up Your System
• Create a Sphinx Project
• Glossary Terms

Set up Sublime

• Install Sublime Packages
• Create Macros
• Customize Sublime
• Use Snippets as Shortcuts

Work with reStructured Text Content

• Write Topics
• Create Tables of Contents
• Use Lists
• Use Notes and Warnings
• Show Example Code
• Use Tables
• Add Links
• Add Images
• Add Videos
• Use Inline Formatting
• Use Conditional Text
• Add a Glossary
• Reuse Content

Manage Content in GitHub

TBP

Deliver Documentation

• Use Themes
• Customize Styles
• Build the Project
• Use Read the Docs