Read the Docs Newsletter - August 2024
Photo by Padre_moovi on Unsplash

Photo by Padre_moovi on Unsplash

News and updates

We posted two blog posts this month covering important things:

We also have some updates on our platform:

  • We have a couple new versions of our Sphinx theme coming out, 2.1.0rc1 that supports Addons, as well as 3.0 to support Sphinx 8.
  • We officially removed support for Google Analytics, which we historically had used for global statistics, but are now able to get good enough stats from CloudFlare and our own Read the Docs analytics.
  • API v3 now supports unauthenticated requests for many endpoints, which should make it easier to integrate in documentation pages.
  • We have marked Addons and Build Customization as generally available, no longer having a Beta label, as we're now confident in their stability and usability.
  • Our docs are getting consistent updates to add Addons, and work to improve the way we're explaining our core features like Versioning and Builds.

You can always see the latest changes to our platforms in our changelog 📃.

Upcoming changes

  • We're working on a project to make it easier to understand what files have changed between versions, which will allow us to build a number of neat features like Redirect recommendations, and Pull Request page review suggestions.
  • Adding Two Factor Auth (2FA) is also currently under design discussion, and we hope to release it in the next few months.
  • We are looking at adding functionality similar to our sphinx-hoverxref extension to our new documentation system, which support popups for cross-references in a single documentation page. This will work for all documentation tools, not just Sphinx.
  • We are planning to move our official documentation to https://docs.readthedocs.com to make it more obviously official. This should be a seamless transition for users, but we will be updating links in our documentation and on our website to reflect this change.

Want to follow along with our development progress? View our development roadmap 📍️

Possible issues

  • As we noted above, we are shipping Addons to all users on October 7, which also means that Sphinx users will be migrated to the new build system. This will have some backwards incompatibilities, so we recommend reading our blog post to understand the changes.

Questions? Comments? Ideas for the next newsletter? Contact us!