Read the Docs newsletter - July 2022¶
Summer has come, which means our overall development has slowed a bit as the team takes some well-deserved vacation time. That said, we’re still excited about our recent hire and the ongoing work we’ve been doing to support the documentation ecosystem.
Our focus for Q3 (July-Sept) of 2022 is around improving our frontend and marketing pages. This includes a fancy new marketing website, as well as a revamped dashboard UX that will make many features nicer for our users.
We’ve continued building a number of features and bug fixes in our roadmap:
We have shipped an initial set of Example projects, which allow users to get started quickly with Sphinx and MkDocs. We will add more examples in the upcoming month, the first one will be a Jupyter Notebook example. If you have any particular ideas in mind or know of a really cool real-world project that others should check out, please don’t hesitate to reach out.
We added support for HTML theme authors to define where our flyout menu is put in their documentation pages. This is an ongoing effort to allow theme authors to integrate our features nicely into the look & feel of docs.
sphinx-hoverxref works nicely with Jupyter Book now and we fixed manual references.
We improved the UX around VCS support and pull request previews, so that it’s more obvious how to enable the notifications on your repository, and warn you if you don’t have your account configured correctly.
To better support security, we have enabled Content Security Policy headers on our main dashboard sites. You can contact support if you’d like to enable this on your own documentation domain.
We have improved our dashboard translation workflow, so that translations are now deployed each week, making our site easier to use for many folks around the world.
You can always see the latest changes to our platforms in our Read the Docs Changelog.
Awesome documentation projects¶
We are collecting entries for Awesome Read the Docs Projects - please do tell us about your favorites, either by sending an email or opening a Pull Request!
Setuptools has made use of many cool theme settings and displays syntax alternatives in a tabbed interface – see our 🧵 on Twitter
disnake uses many light/dark interface tricks and has added many features for browsing API references – see our second 🧵 on Twitter
As mentioned above, we are shifting some of our focus to frontend these next few months. Look forward to some links to allow you to test our our new beta dashboard in the next month or two.
We are working on a Jupyter/Scientific Python example project, to help users in that ecosystem get their docs started quickly.
We’re continuing to focus on outreach for our new build customization features, so that we can continue to improve them with your feedback.
We are actively working to deprecate jQuery from our code, as well as guide the Sphinx ecosystem through the transition.
Considering using Read the Docs for your next documentation project? Check out our documentation to get started!
Questions? Comments? Ideas for the next newsletter? Contact us!
- 12 July 2022
- Eric Holscher
- Bend, Oregon
- newsletter python
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.
- 09 March - Read the Docs website migration to about.readthedocs.com
- 07 March - Read the Docs newsletter - March 2023
- 07 February - Read the Docs newsletter - February 2023
- 10 January - Read the Docs newsletter - January 2023
- 04 January - Sphinx 6 is out and has important breaking changes