Using custom Sphinx templates on Read the Docs
I wanted to make a small customization to one of my documentation templates on Read the Docs. It turns out you can over-ride the default templates by creating a directory in your documentation folder…
readthedocs
7 posts tagged “readthedocs”.
- 2025
-
1 min read
- 2024
-
Updating stable docs in ReadTheDocs without pushing a release
I use ReadTheDocs for several of my projects. It's fantastic: among other things, it makes it easy to publish the documentation for my latest branch at and the documentation for my latest release at…
7 min read -
Pointing a custom subdomain at Read the Docs
I host the documentation for Datasette on Read the Docs. Until today it lived at https://datasette.readthedocs.io/ but today I moved it to a custom subdomain, https://docs.datasette.io/ Most of this…
1 min read -
Running pip install '.[docs]' on ReadTheDocs
I decided to use ReadTheDocs for my in-development datasette-enrichments project. Previously when I've used ReadTheDocs I've had a folder in my project with its own file containing the requirements.
1 min read -
Promoting the stable version of the documentation using rel=canonical
I was thinking about documentation SEO today. Like many projects, Datasette offers multiple versions of the documentation: - https://docs.datasette.io/en/latest/ is the latest branch on GitHub -…
1 min read - 2023
-
Read the Docs Search API
I stumbled across this API today: https://docs.datasette.io/ /api/v2/docsearch/?q=startup&project=datasette&version=stable&language=en It's used by the search feature at…
1 min read -
Linking from /latest/ to /stable/ on Read The Docs
Read The Docs has a handy feature where documentation for older versions will automatically link to the latest release, for example on this page: That feature is enabled by a "Show version warning"…
1 min read