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.
Company highlights¶
- 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.
- The first version of the tutorial we contributed to the official Sphinx documentation is online, as part of the new Sphinx 4.1 releases, and we are already working on expanding it. We thank the Sphinx maintainers for the thorough reviews and CZI for making it possible.
- We are now tracking changes in our database, which will help us with support issues and additional auditing features on Read the Docs for Business.
New features¶
- We added support for Python 3.10b4 in our
testing
Docker images! The final 3.10.0 release will be in October, but you can already test a development version. - Our commercial site now allows pull request previews to be public rather than private only, and to control the privacy level of pull request builds as well. As a result, we have dropped privacy levels for projects on our community site, since they used to be a source of confusion.
- We released sphinx-hoverxref 0.7b1, which adds compatibility with Sphinx 4.1.
- We fixed a long-standing usability issue in both our community and commercial sites: notifications now have a close button.
You can always see the latest changes to our platforms in our Read the Docs Changelog.
Upcoming features¶
- Ana, our new hire, will spend some time getting familiarized with our development practices and tools, and perform some quality assurance on the upcoming new version of our Sphinx theme along with Anthony.
- Anthony will work on onboarding Ana, release a first release candidate of version 1.0 of our Sphinx theme, and some finance work.
- Eric will continue overseeing the implementation of the next stages of our audit tracking along with Santos, doing code review, and improving our sales & marketing processes.
- Juan Luis will expand the Sphinx tutorial while doing basic bug triaging for the project, and start with a much needed tutorial for Read the Docs itself.
- Manuel will keep working on our Embed API version 3, push the final tweaks needed to support Python 3.10 along with Santos, and continue improving our deployment processes.
- Santos will continue with the implementation of our audit tracking, inform our users about the upcoming changes in privacy levels on our community site, and wrap up the work around sharing specific versions of commercial projects.
Possible issues¶
Projects that were using Git LFS on our site noticed that it stopped working at the end of June. Even though it is not officially supported from our side, we wanted to make it work again, but it took several days to understand what was happening.
Considering using Read the Docs for your next Sphinx or MkDocs project? Check out our documentation to get started!