Read the Docs newsletter - May 2021¶
Welcome to a new edition of our monthly newsletter, where we openly 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.
The team keeps growing! Ra will join us next week to do account management for EthicalAds.
We reworked our deploy procedure to almost remove the need to interrupt builds. Therefore, you should see less build retries during our deploy timeframe, normally Tuesday morning Pacific time.
After some careful deliberation, we started the process to deprecate recommonmark in favor of MyST, a better maintained alternative. We are excited to see that some projects have already migrated without effort, and we are looking forward to helping MyST-Parser thrive! Thanks to the Executable Books Project folks for creating this project.
Our frontend developer position is still open! We are actively looking for candidates, if you know people that could potentially be interested feel free to forward them the link above.
We improved several areas of our contributor documentation: we added more detailed steps on how to contribute to our docs (both from the GitHub UI and from your own computer), and we expanded our development installation guide with more clear instructions for static assets and some extra verification procedures. Thanks Coco for this contribution!
We rolled up a new keyword detection algorithm in our ad client, which should make the ads you see more meaningful and useful.
We are about to disable Federated Learning of Cohorts (FLoC) on our dashboard as well as on documentation sites because of privacy concerns. On Read the Docs and EthicalAds, we maintain our commitment to avoid user-targeted advertisement, and use only contextual targeting instead.
Current focus & known issues¶
We are working with the Sphinx maintainers to help testing the upcoming Sphinx 4.0.0 release and decrease the risk of breakage. It is an ongoing effort that requires finding a balance between stability and maintainability, and we hope we can do the best for our users and the Sphinx community. Read the release notes to check for any breaking changes, and if in doubt, pin your declared dependency to
Cloudflare has changed how their SSL works, so we’re figuring out how that might impact users of custom domains on our Community site. It will likely only impact projects that are proxying to us, not domains that follow our recommended custom domain configuration.
Anthony will keep working on releasing sphinx_rtd_theme 1.0, start getting users to test our new user interface, and iron out our Data Processing Agreements.
Eric is focused on onboarding our new hire on the EthicalAds team, finishing a CZI grant proposal for funding in 2021-2022, and figuring out how the team can handle growing from 5 to 8 folks in 2021!
Manuel will continue improving our operations and deployment procedures, make single sign-on discoverable by users, and release a new version of sphinx-hoverxref compatible with newer versions of Sphinx and MathJax.
And finally, Santos will wrap up our new infrastructure and configuration changes allowing users to install custom apt packages.
Considering using Read the Docs for your next Sphinx or MkDocs project? Check out our documentation to get started!
Subscribe to our mailing list
Sign up for our blog and we'll send you news and updates about Sphinx and Read the Docs on a regular basis.
You have successfully joined our subscriber list.
- 10 January - Read the Docs newsletter - January 2023
- 04 January - Sphinx 6 is out and has important breaking changes
- 06 December - Read the Docs newsletter - December 2022
- 14 November - Override the build process completely with build.commands
- 07 November - Read the Docs newsletter - November 2022