Recent posts¶

• 14 December - Read the Docs newsletter - December 2021

  Welcome to the latest edition of our monthly newsletter, where we share the most relevant updates around Read the Docs, offer a summary of new features we shipped during the previous month, and share what we’ll be focusing on in the near future.

  We successfully deployed mitigation measures against spam, and we are happy to report that the amount of abusive projects has dramatically decreased.

• 07 December - Announcing Embed API v3 and sphinx-hoverxref 1.0

  We are thrilled to announce the availability of Read the Docs Embed API v3, along with its official client, sphinx-hoverxref 1.0. This work has been possible in part thanks to the the CZI grant we received.

  As we wrote in our first blog post about sphinx-hoverxref, one of the most powerful features of Sphinx is the possibility of creating cross references to other documentation projects. However, a reader finding several links in a technical documentation might need to open several browser tabs to fully understand the context, resulting in a lot of friction in the form of context switching.

• 11 November - Read the Docs ❤️ Jupyter Book

  We are proud to announce that now Jupyter Book projects are supported on Read the Docs!

  Both Read the Docs and The Executable Book Project, the folks behind Jupyter Book, share a common passion for documentation, and we have been collaborating on various topics for some time already. For example, we started promoting MyST in favor of our recommonmark back in April this year, and we wrote a guide on using Jupyter notebook with Sphinx that benefitted a lot from their feedback.

• 04 November - Read the Docs newsletter - November 2021

  Welcome to the latest edition of our monthly newsletter, where we share the most relevant updates around Read the Docs, offer a summary of new features we shipped during the previous month, and share what we’ll be focusing on in the near future.

  During the first week of November we attended the 2021 Essential Open Source Software for Science Annual Meeting, an event organized by the CZI Science team. We are thrilled to connect with projects in the Open Science ecosystem.

• 02 November - Build errors with docutils 0.18

  Starting about a week ago, some users started reporting new errors with their project builds. In most cases, these errors appeared out of nowhere and are usually rather cryptic errors referencing Sphinx and docutils.

  So, what is happening?

• 14 October - Ubuntu 20.04, Python 3.10, and support for Node, Rust, and Go

  We are excited to announce that now Read the Docs users can use a newer build specification in their projects that will change the base image to one based on Ubuntu 20.04, ship the recently released Python 3.10, and allow users to easily specify the version of Node.js, Rust, and Go. This feature has been a long time in the making, and we think it will simplify the configuration of many projects.

  The Docker images used by our builders were based on Ubuntu 18.04. Recently, we added a new feature to install custom system packages, which allowed many projects to have better control of their build process without having to use conda to manage non-Python dependencies.

• 07 October - Read the Docs newsletter - October 2021

  Welcome to the latest edition of our monthly newsletter, where we share the most relevant updates around Read the Docs, offer a summary of new features we shipped during the previous month, and share what we’ll be focusing on in the near future.

  We have resumed sending our blog updates by email. You can subscribe to our newsletter so you don’t miss them.

• 02 September - Read the Docs newsletter - September 2021

  Welcome to the latest edition of our monthly newsletter, where we share the most relevant updates around Read the Docs, offer a summary of new features we shipped during the previous month, and share what we’ll be focusing on in the near future.

  We have published the first release candidate of version 1.0.0 of our Sphinx theme, which adds support for recent versions of Sphinx and docutils among other things, and announced our future plans for it. Check out the linked blog post to know more. Update: We have released 1.0 to PyPI

• 23 August - Theme release 1.0.0rc1

  The 1.0.0 version of sphinx_rtd_theme was released Sept 13, 2021. You can install the latest version with:

  Alternatively, you can upgrade the version installed using:

• 09 August - Read the Docs newsletter - August 2021

  Welcome to the latest edition of our monthly newsletter, where we share the most relevant updates around Read the Docs, offer a summary of new features we shipped during the previous month, and share what we’ll be focusing on in the near future.

  We have a new team member! Ana just joined us as Frontend Developer in the context of the CZI grant we were awarded to work on our JavaScript documentation embedding client and the Read the Docs redesign and UX.