Read the Docs newsletter - April 2023¶
News and updates¶
📚️ Over the past ~6 months, we gradually refactored our user documentation to align with the Diátaxis Framework. The results are now manifested in the structure of the navigation sidebar and the landing page on docs.readthedocs.io.
📊️ All of our websites now use Plausible for analytics.
⚙️ Added a new build variable
READTHEDOCS_CANONICAL_URLthat’s useful for projects that need the canonical base URL while building. View docs.
⚙️ Added new build variables
READTHEDOCS_GIT_COMMIT_HASHfor projects that need to access Git data while building. View docs.
🔒️ Fixed vulnerability: Cache poisoning: serving arbitrary content on documentation sites
You can always see the latest changes to our platforms in our Read the Docs Changelog.
📚️ We are still doing changes in our user documentation structure and content: Once the last parts of the plan are implemented, we are ready to share a bigger announcement.
The new library is useful for any documentation framework or static site generator to allow for full control of the new flyout menu, integrated search and general access to API data. See the screenshot further down where the integrated search in action on the documentation framework Docusaurus.
We plan to be rolling this out gradually for Sphinx and MkDocs projects that are currently running their own set of
build.commands. Once that happens, we’ll be back with news on the blog and documentation about how you can configure it.
Want to follow along with our development progress? View our full Roadmap 📍️
Awesome project of the month¶
Crate.io has integrated 15 Sphinx projects in the same website experience and written their own theme. So they rightly deserve to be this month’s addition to Awesome Read the Docs Projects 🕶️. See the highlights in the following Twitter thread or Mastodon thread:
A recent addition to our list of awesome projects 🕶️: @crateio @crateio combines multiple documentation projects into the same website experience.— Read the Docs (@readthedocs) April 4, 2023
Oh, by the way, the @crateio docs will turn 10 years old in July 🎂️https://t.co/4cQMj3SNx6
Here is a 🤏 (small) 🧵 pic.twitter.com/tqP1dH5czb
Questions? Comments? Ideas for the next newsletter? Contact us!
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.
- 05 September - Read the Docs newsletter - September 2023
- 31 August - Addons flyout menu beta
- 24 August - Enabling latest versions for Sphinx & Mkdocs builds
- 09 August - Use build.os instead of build.image on your configuration file
- 08 August - Drop support for “Use system packages”