12 August 2020
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.
26 July 2020
List of common Sphinx, Docutils and reStructuredText warnings and errors. Each issue is well explained, illustrated by an example, and offers solution.
13 July 2020
If you starting writing in reStructuredText, you will quickly find it’s not always intuitive. In this Sphinx and reStructuredText guide, you’ll find explanation in plain English of syntax, elementary concepts and important pitfalls to avoid.
Recent posts
You might also want browse all posts archive.
15 October 2021
Localization with gettext is streamlined process with responsibility distributed among original messages author, gettext tooling, and translator or translator tools. This post will help you understand extracting messages and starting new translation.
15 October 2021
Gettext is internationalization (i18n) mechanism and library used not only in many software products, programming languages but also for translating Sphinx documentations. Gettext extracts strings marked “to-be-localized” from a source code (or a document) to plain text file with .po or .pot file extension. Let’s look at its format.
26 April 2021
Developing extensions for Sphinx documentation projects can easily grow into a big Python project. Debugging with print() quickly becomes a no-go. Let’s have a look how to debug Sphinx extension of any size.
13 April 2021
Over the years writing documentation in Sphinx, I found I do the same tweaks in every Sphinx project’s conf.py again and again. Here are the best ones.
07 April 2021
This week, I’m working on Documatt Sphinx Theme, a theme used for example in this blog. One of the longest postponed feature is displaying a local table of contents (ToC) in the right sidebar. By default, Sphinx displays a current document title in the local ToC, so let’s fix it.
13 August 2020
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
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 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.
Tags
Click to tag or see list of all tag and their posts.