Mastodawn

Experimentally, it seems like pushing new "build style" semver tags is sufficient to get #ReadTheDocs / #RTD to update its 'stable' pointer. That'll probably do for now?

E.g., I cut Paramiko 5.0.0+rtd1 and pushed it to GitHub but nowhere else (as it is literally 5.0.0 + a change to my RTD config files which do not impact any users or even contributors, really) and I'm seeing a rebuild w/ its SHA 🎉

Still more friction than I remember, but at least it's better than making a whole new release!

Show thread

Jeff Forcier May 9

Weird, I could /swear/ #ReadTheDocs' 'stable' version used to track branches only, but the docs and changelog imply it's been branches /or tags/ (and critically, /favoring the latter when both exist/) since like 2018? Am I high?

The behavior as-is makes it hard to push #RTD-only or doc-only changes w/o cutting a whole new tag (and of course, cutting a whole new tag w/o releasing any code to PyPI, looks weird).

I.e., I can't just push a minor config tweak to my 5.0 branch to fix an issue with the 'stable' docs.

Somewhat ironically, my own changelog setup still creates links to 'latest' instead of 'stable' 🙃 but 'stable' is the default otherwise…

David's Neighbour Mar 21

One of the most hidden super-cool (sorry, born in the 70s) features of #tailwindcss is the `group` class. Put it on an outer div, then inside do a `group-hover:crazy colors` thing and be impressed. #readthedocs (at least once fully): https://tailwindcss.com/docs/hover-focus-and-other-states#styling-based-on-parent-state

Hover, focus, and other states - Core concepts

Using utilities to style elements on hover, focus, and more.

Nami Sunami 🟥Mar 18

> First, verify that Actions is enabled for your repository. Visit your repository settings, and go to Units > Overview.

Folks, don't forget to read the docs!

https://forgejo.org/docs/next/user/actions/quick-start/#:~:text=First%2C%20verify%20that%20Actions%20is%20enabled%20for%20your%20repository%2E%20Visit%20your%20repository%20settings%2C%20and%20go%20to%20Units%20%3E%20Overview

#readthedocs

Forgejo Actions | Quick start guide | Forgejo – Beyond coding. We forge.

musicmatze

Mar 13

#readthedocs has max-width 800px ... yeah, my wide screen monitor 🥱

#uidesign at its best!

Show thread

AstraLuma #PyConUS Feb 4

I was joking about this, but #ReadTheDocs doesn't support Forgejo yet.

So I have to decide if I want well-supported tools or if I want to get off the major commercial platforms.

Alex Willmer Jan 21

Linking to some Python package docs? Replace <pkg>.readthefinedocs.io with <pkg>.rtfd.io to save a few precious characters. It's an official redirect https://docs.readthedocs.com/platform/latest/user-defined-redirects.html#shortlink-with-https-slug-rtfd-io #Python #ReadTheDocs

Redirects

Over time, a documentation project may want to rename and move contents around. Redirects allow changes in a documentation project to happen without bad user experiences. If you do not manage URL structures, users will eventually encounter 404 File Not Found errors. While this may be acceptable i...

Read the Docs Documentation

TheProtocols Jan 7

Our website is refreshed! Please check out our new website based on #mkdocs with #readthedocs theme:

TheProtocols Documentation

TheProtocols Documentation

TheProtocols is a federated protocol for decentralizing super apps by letting people choose a network and a client they want.

Show thread

Nikita Karamov Nov 3, 2025

I feel like this is a very common problem amongst #Python libraries. Most use #ReadTheDocs to host documentation, and the default template has no obvious way to include a link back to GitHub that is visible on every page. One can show the source code of a function/class in the API docs / autodoc, but it's not the full repo. I'd prefer everyone to add an external toctree link to the source code, but I haven't seen anybody doing this.

As a result, when I search for a Python library on the web, the first search result is the RTD page, the second one, if I'm lucky, is the #PyPI page, but the source code is nowhere to be found, and I have to go look for it (often by clicking "Edit this page" in the docs, then manually trimming the URL) :/