Posted in 2025
Sphinx Translation Tutorial: Localize Your Docs Like a Pro on Sep 01, 2025
Localizing documentation, manual, or help is a challenging task. But it’s also an area where Sphinx documentation generator really shines. Sphinx gives you strong tooling for the entire lifecycle from initial translation to keeping translation(s) up to date with constantly changing original. In this tutorial, I will guide you through the full translation workflow using a minimal yet realistic Sphinx documentation example.
How to add numbered images to tutorials in Sphinx on Jul 04, 2025
Learn how to add numbered images to Sphinx tutorials with SVGs, Markdown, and reStructuredText. Often in step-by-step HOWTO guides, we want to refer to a certain point on a screenshot. For example, “Delete a book (4)”, where (4) refers to the (4) in the screenshot. Explore together more aesthetically pleasing alternatives to plain text “(4)”.
Different template for a document in Sphinx on Mar 06, 2025
The infrequently used Sphinx conf.py html_additional_pages option is very valuable if you need to customize some pages in your Sphinx documentation website, while most are identical.
What is Sphinx built-in search, and how to use it in themes? on Jan 10, 2025
Sphinx is a powerful documentation generator with features that enhance content usability. Its built-in search offers a simple way to find information within your documentation. This guide will help you implement and customize Sphinx’s search in your themes for a better user experience for documentation readers.
