Techwriter at work blog.

Living and writing documentation at Documatt, small team of programmers that do write documentation too.


Posts in top

Sphinx theming guide

  • 12 August 2020
  • Author: Matt
  • Category: top

Tech writers should write. Delivering documentation in a visually appealing manner is almost the same important as the content itself, however. Sphinx themes are “skins” that define look & feel of documentation when outputted to HTML format. In this guide, you will learn how to customize existing or create a new theme from scratch.

Read more ...


Sphinx errors

  • 26 July 2020
  • Category: top

List of common Sphinx, Docutils and reStructuredText warnings and errors. Each issue is well explained, illustrated by an example, and offers solution.

Read more ...


reStructuredText and Sphinx syntax

  • 13 July 2020
  • Author: Matt
  • Category: top

If you starting writing in reStructuredText, you will quickly find it’s not always intuitive. In this Sphinx and reStructuredText syntax guide, you’ll find explanation in plain English of elementary concepts and important pitfalls to avoid.

Read more ...