RST Workshop: Overview¶
This documents provides a workshop audience with essential information about reStructuredText (RST).
The workshop goals are:
Give the participants enough information to get them started using RST.
To prompt the participants to think if RST is right for them.
This workshop guides the learner through these topics:
Paragraphs and Inline Styles
Paragraph Level Markup
Lists and Tables
Menu and Navigation
Documenting Source Code (sphinx.ext.autodoc)
Some participants are IT professionals or developers who want to learn how Sphinx works. Therefore, the content of the workshop documentation will be on setting up Sphinx on a Linux server.
The result of this activity is found on page RST Workshop: Setting up a Sphinx Server.
Workshop Resource List¶
This list of curated sites will help you complete the tasks. Some sites explain some components better than other sites. Therefore, each task will put a link to the site that provides a clear explanation on how to complete it.
This document! Click the
View page sourcein the upper right hand corner to see the source code.
Create documentation using RST.
Getting Sphinx Running.
- Overall Goal
You will create RST files that document how to set up Sphinx on a server and to serve the rendered content using Nginx.