RST Workshop - Germany 2020

This workshop has two components:

1. Writing documentation using reStructuredText (RST)

2. Setting up a Sphinx server

Afterwards, follow the instructions to set up a Sphinx server for your documentation. Or, just build a Docker images using the template Dockerfile. There are two variations:

1. Debian - Well supported packages, stable

2. Alpine - Small footprint

Workshop Support Docs

• RST Workshop: Presentation
• Windows Development Environment
• RST Workshop: Setting up a Sphinx Server
• RST Workshop: Docker Environment

Workshop Tasks

• RST Workshop: Overview
• RST Workshop: Development Environment
• Task 1: Page Structure
• Task 2: Paragraph and Links
• Task 3: Note Boxes
• Task 4: Nested Lists
• Task 5: Code Blocks
• Task 6: Embed Images
• Task 7: Menus and Navigation
• Task 8: Advanced Topics
• Task 9: Autodoc