Posted in 2024
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.
3 Steps for Release Notes Which Users Will Love
- Oct 18, 2024
Release notes (RNs) are a specific type of documentation for software applications. No matter if you call it changelogs, announcements, or ‘what’s new’. Unfortunately, they’re often poorly maintained or missing altogether because people tend to skip over them.
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.
Documatt 1.0 released. Finale or startline?
- Jun 26, 2024
🎉 Documatt is finally here 🎉. For everyone, not just our friends and fellow tech writers. After 12+ months of development and 6 months of closed beta, you can now author in Markdown/reStructuredText and host your next documentation with us.
