Posts tagged sphinx
How to insert video to Sphinx document
- Nov 21, 2024
Although it sounds easy, it’s not straightforward. Sadly, pure Sphinx and the underlying library Docutils do not directly support inserting videos into documents. But we will show you two approaches to insert it anyway.
Sphinx Themes: Permalinks to heading
- Oct 15, 2024
Permalinks are small anchors next to the heading which allows to copy and share URL directly to that heading within the page. By default, Sphinx generates those permalinks with ¶ character (the paragraph sign), but the most themes hides it until heading mouse hover.
Project-specific Sphinx Themes
- Oct 15, 2024
As explained in our Sphinx Themes: Introduction, the theme is basically a folder with theme.toml, some Jinja HTML templates and static files.
Sphinx Versions Summary
- Jun 26, 2024
On this page, we’ll summarize a few recent Sphinx releases. We don’t want to duplicate the official Sphinx changelogs, but briefly highlight the most important changes and list supported Python and Docutils versions.
Debugging Sphinx extensions
- May 26, 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.
Best Sphinx conf.py tips
- May 13, 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.
CSS to remove document title from Sphinx local ToC
- May 07, 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.
How to modify Sphinx theme?
- Aug 13, 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 post, you will learn how to customize existing or create a new theme from scratch.
Sphinx Themes: Introduction
- Aug 12, 2020
Sphinx theme is a collection of files that changes the appearance of HTML version of the documentation. It contains HTML templates, CSS stylesheets, and static files like images, favicon, fonts, etc.
How to add a sitemap to the Sphinx project?
- Jul 02, 2020
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.