Read the Docs newsletter - January 2023
Happy 2023!
News and updates
Here are the latest updates from our team since the previous newsletter:
📹️ Eric delivered a talk at DjangoCon US 2022 with practical tips for developing state of the art documentation projects.
You can watch it here: Documenting Django Code in 2022
🛠️ In line with the talk,
we continued reorganizing our own documentation to follow the Diátaxis Framework.
🚢️ Sphinx 6.0 and 6.1 have been released.
If you want things to not break,
it’s good to wait a bit.
Read our considerations for upgrading.
🔒️ We fixed a security vulnerability on our platform. See: GHSA-368m-86q9-m99w
🔒 We immediately rotated Circle CI secrets as advised by Circle CI.
Read the Docs did not share secrets with Circle CI for build infrastructure,
nor do we see any signs that other secrets have been suspiciously accessed.
You can always see the latest changes to our platforms in our Read the Docs Changelog.
Upcoming features
The core team has laid out its 2023 Q1 roadmap and our general focus will be on:
Improving support for using any documentation tool in the build process.
Currently, users can either customize a default build process or overwrite the entire process from scratch.
We are aligning these two approaches,
making it easier to design and configure builds for a project’s individual needs.
Continuing to restructure and rewrite the user documentation of Read the Docs.
We look forward to publishing the restructured documentation which is likely happening at the end of Q1.
Dashboard redesign: Our admin dashboard is currently being redesigned and reimplemented.
We are targeting the work to be presented in a public beta.
Interested in all the details? View our full Roadmap 📍️
Possible issues
Sphinx users should be aware that Sphinx 6.0 and 6.1 were released very recently.
If you haven’t pinned dependencies,
the update might come automatically.
If you choose to update,
there are a few things to be aware of.
Read our considerations for upgrading.
If the release of Sphinx 6 has made your builds fail,
it may be because you are not pinning your dependencies.
We recommend reading our introduction to Reproducible Builds.
Awesome Project of the month
GeoPandas is an open source project for working with geospatial data which requires a lot of exciting features from the documentation - maps, plots etc. We especially like how the documentation is structured. See all the highlights in the following Twitter thread:
Awesome Read the Docs Projects List 🕶️
Looking for more inspiration?
Check out our new list Awesome Read the Docs Projects
and help us discover more awesome projects.
Read the Docs Blog