Posts tagged sphinx
How to insert video to Sphinx document on 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 Versions Summary on 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 on 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 on 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.
How to modify Sphinx theme? on 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.
How to add a sitemap to the Sphinx project? on 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.
