Techwriter at work blog.

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


12 August 2020

Sphinx theming guide

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.

13 July 2020

reStructuredText and Sphinx syntax

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.



Recent posts

You might also want browse all posts archive.

13 August 2020

How to modify Sphinx theme?

Do you like your current HTML theme for Sphinx documentation project, but want only to change font family, increase the font size, change colors, and similar minor customizations? Learn common ways to customize and modify Sphinx themes.

12 August 2020

Sphinx theming guide

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.

12 August 2020

Sphinx themes

Sphinx theme is skin that changes the appearance of HTML version of the documentation. It contains HTML templates, CSS stylesheets, and static files like images, favicon, fonts, etc.

13 July 2020

reStructuredText and Sphinx syntax

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.

13 July 2020

Showing code examples

In almost any technical documentation you need to show bits of code, filenames and paths, commands and console examples. They are usually styled in monospace font with optional syntax highlighting.

13 July 2020

Sections – structuring document

Document structure is hierarchy of its sections. reStructuredText calls heading the section and takes different approach on section leveling than you probably expect. Section titles are decorated with the punctuation characters and importance (a section level) depends on its usage order in document.

13 July 2020

Admonitions

Admonitions are specially marked blocks that can appear anywhere an ordinary body element can. Readers will appreciate if you spice up your text with admonitions like tip for extra information or warning to raise their attention.

02 July 2020

How to add a sitemap to the Sphinx project?

Sitemap is essential part of making your website more visible for search engines. It is usually represented by the sitemap.xml file and lists URLs of all website pages, translations of pages in alternative languages, etc. sphinx-sitemap extension can easily generate sitemap for your Sphinx documentation project.


Tags

Click to tag or see list of all tag and their posts.