10 January - Read the Docs newsletter - January 2023
Here are the latest updates from our team since the previous newsletter:
04 January - Sphinx 6 is out and has important breaking changes
Sphinx 6 was released on December 29, 2022. It contains a few major breaking changes that users should be aware of, and some smaller new features as well. Here are some of our considerations for the upgrade process:
Python 3.8+ is required. To enable this on Read the Docs, you will need to specify a Python version using the build.tools.python setting. If it’s possible for your project, you can make the jump all the way to Python 3.11.
06 December - Read the Docs newsletter - December 2022
This newsletter contains the first features and updates that have hatched since we announced a Q4 focus on core platform features in the previous newsletter.
Here are the latest updates from our team:
We are happy to announce a new beta feature that allows users to override the Read the Docs build process completely. We previously talked about executing custom commands in-between the Read the Docs build process. That approach is not sufficient for projects with a heavily customized build process, or those that want to use a different documentation tool like Pelican, Docsify and Docusaurus for their documentation. Some of which were not able to use our platform at all. Until now! We have good news for them!
The new configuration file option
build.commandsallows projects to only execute exactly the commands they want. No more. No less. This means that Read the Docs won’t execute any of the default commands behind the scenes. You have 100% control over the build process.
07 November - Read the Docs newsletter - November 2022
Here are the first features and updates that have hatched since we announced a Q4 focus on core platform features in the previous newsletter.
The latest updates from our team:
01 November - Announcing sphinx_rtd_theme 1.1.0
We are happy to announce the release of new version of our theme, sphinx-rtd-theme. In this release, we have focused on bug fixes, backwards compatibility, and making the way for future releases.
Visually, we have a couple of small tweaks that most people won’t notice unless we mention them here 😇 The objective of the 1.1 release is to maintain backwards compatibility, and that also goes for the visual parts.
25 October - GitLab service re-connection required
Some months ago GitLab started enforcing an expiration time of two hours for all of their OAuth tokens.
Unfortunately this broke the integration with our application, so your OAuth tokens may have expired. OAuth tokens are used to interact with the GitLab API, for reporting the status of merge requests, creating webhooks, and listing repositories. In order for Read the Docs to have access to new fresh tokens, you need to re-connect your GitLab account. You can do this by:
12 October - Read the Docs newsletter - October 2022
September was exciting because a few members of our team finally got to gather in person. Manuel, Benjamin, and Eric all attended Djangocon Europe in September, and had lots of great discussions around documentation.
Also, as we mentioned, in Q4 we’re going to be focusing on our core platform features. This means we’ll have fewer new features to talk about, but lots of smaller improvements to the overall experience of using Read the Docs.
Read the Docs allows you to keep your documentation up to date in a simple way, by triggering a new build each time developers push a git repository. Depending on your workflow, there could be situations where multiple pushes are done during a short time window. This causes a situation where you have to wait a long time for a build that will be immediately overwritten.
To avoid waiting for those builds to be executed, we implemented a new feature to cancel these useless builds and only execute the latest one. This considerably improves the user experience and also reduces resource costs and energy waste.
13 September - Knowing more about how people use our service
Read the Docs generates a lot of data. We are the largest documentation platform out there, with hundreds of thousands of projects using our product every day to host their documentation. This data includes simple things like number of users, builds using a particular Docker image, as well as more interesting ones like pageviews or Python dependencies installed via a
requirements.txtfile. We didn’t collect this data in a systemic way during the first 10 years of our existence.
Last year, with the growth of our product and the team, plus the CZI grant we received, we started asking ourselves some questions that we couldn’t answer with the data we had. We decided to start working on a project to collect relevant data to answer a large number of questions about how people use our service.