I just transferred an open-source project from GitHub to Codeberg π.
Thanks to the good documentation at https://docs.codeberg.org/integrations/read-the-docs/, setting up the integration with Read the Docs was straightforward. β
I just transferred an open-source project from GitHub to Codeberg π.
Thanks to the good documentation at https://docs.codeberg.org/integrations/read-the-docs/, setting up the integration with Read the Docs was straightforward. β
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!
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β¦
> 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!
#readthedocs has max-width 800px ... yeah, my wide screen monitor π₯±
#uidesign at its best!
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.
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...
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) :/