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.

Company highlights

  • 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.

  • We upgraded our systems to Python 3.8 and Ubuntu 20.04 LTS. This will allow us to leverage newer Python features and use more up to date dependencies.

  • The Read the Docs tutorial we started writing as part of the CZI grant we received is now complete! We plan to keep updating it with user feedback and keep improving other parts of our documentation.

New features

Thanks to our external contributors Adam Dangoor, Arthur Milchior, Carlton Gibson, Deepto, Jürgen Gmach, and Maksudul Haque.

You can always see the latest changes to our platforms in our Read the Docs Changelog.

Upcoming features

  • Ana will be working on bringing the mockups of our new landing pages to reality.

  • Anthony will keep working on finances and taxes, and helping Ana with the frontend work.

  • Eric will send out a report for our grant work, and work with Santos on implementing CloudFlare for our corporate site.

  • Juan Luis will work on moving our development documentation to a separate project, finish the Sphinx tutorial, spread the word about MyST Markdown, and promote our Embed API.

  • Manuel will add mechanisms to fight spam in our platform and improve our internal metrics.

  • Santos will wrap up the custom outgoing webhooks and keep unifying the code of our community and commercial sites.

Possible issues

The docutils 0.18 release from late October is incompatible with older versions of Sphinx, which are still used by a significant number of projects on Read the Docs. A large number of them were not pinning their dependencies and have experienced broken builds, which has resulted in a large number of issues and support requests. We have written a blog post explaining the situation and the ways to solve it.

Considering using Read the Docs for your next Sphinx or MkDocs project? Check out our documentation to get started!