Tag: reStructuredText

A close up of many old, random metal letters with copy space

Creating Manuals Using RST and Sphinx: Text Formatting

ReStructuredText is one of the more persnickety documentation ‘languages’ out there. Blank lines and spaces can often be the difference between a lovely end document and absolute chaos. In this post, I’m going through the basic text formatting options that you’ll need to create a clear, readable document.

Creating Manuals Using RST and Sphinx: Base Documents

In Sphinx project, ‘base documents’ are like the skeleton of a manual. In a table of contents, they’ll show up as the chapter headings.

Creating Manuals Using RST and Sphinx: Master File

A master file controls almost all of the content that will be included in your user manual. It contains a list of your base documents and specifies what your table of contents will look like.

Creating Manuals Using RST and Sphinx: Directory Structure

The source directory structure that you choose will end up embedded in a lot of documents. That includes configuration files and every single internal hyperlink created. It’s possible to go back through and change things later, but it’s also a pain in the neck.

Creating Manuals Using RST and Sphinx: Planning

We can use Sphinx and RST together to minimise ongoing maintenance time and costs. Here are a few of the things to plan before putting your documentation project together.

Creating Manuals Using RST and Sphinx: Installation

This is the first post in a series that will explore using RST and Sphinx to create technical documentation.