#readthedocs — Public Fediverse posts

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. ✅

#Codeberg #ReadTheDocs #Documentation

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!

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!

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!

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!

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…

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…

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…

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…

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…

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

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

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

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

#uidesign at its best!

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

#uidesign at its best!

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

#uidesign at its best!

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

#uidesign at its best!

#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.

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.

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.

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.

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.

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

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

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

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

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

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

TheProtocols Documentation

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) :/

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) :/

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) :/

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) :/

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) :/

Signed up to #readthedocs for an open source project:

https://inema.readthedocs.io/en/latest/index.html

Process was pretty smooth, e.g. it supports github integration,
but it's optional and the service doesn't try to force it on you via dark patterns.
Even pausing for hours during the signup steps was fine,
i.e. session didn't time out or something.

Thus, appreciated the experience, even more so given the general enshittification happening elsewhere.

Signed up to #readthedocs for an open source project:

https://inema.readthedocs.io/en/latest/index.html

Process was pretty smooth, e.g. it supports github integration,
but it's optional and the service doesn't try to force it on you via dark patterns.
Even pausing for hours during the signup steps was fine,
i.e. session didn't time out or something.

Thus, appreciated the experience, even more so given the general enshittification happening elsewhere.

Also migrated my `mvdate` package to Codeberg, moved docs to mkdocs and hosted them on readthedocs.org

Need to release to PyPI on the off chance someone might find it useful.

https://codeberg.org/slackline/mvdate/
https://mvdate.readthedocs.io/en/latest/

Again thanks to those who write and maintain the tools and infrastructure that make it all possible

#python #codeberg #readthedocs #git #magit #emacs #gnu #linux

Also migrated my `mvdate` package to Codeberg, moved docs to mkdocs and hosted them on readthedocs.org

Need to release to PyPI on the off chance someone might find it useful.

https://codeberg.org/slackline/mvdate/
https://mvdate.readthedocs.io/en/latest/

Again thanks to those who write and maintain the tools and infrastructure that make it all possible

#python #codeberg #readthedocs #git #magit #emacs #gnu #linux

Also migrated my `mvdate` package to Codeberg, moved docs to mkdocs and hosted them on readthedocs.org

Need to release to PyPI on the off chance someone might find it useful.

https://codeberg.org/slackline/mvdate/
https://mvdate.readthedocs.io/en/latest/

Again thanks to those who write and maintain the tools and infrastructure that make it all possible

#python #codeberg #readthedocs #git #magit #emacs #gnu #linux

Also migrated my `mvdate` package to Codeberg, moved docs to mkdocs and hosted them on readthedocs.org

Need to release to PyPI on the off chance someone might find it useful.

https://codeberg.org/slackline/mvdate/
https://mvdate.readthedocs.io/en/latest/

Again thanks to those who write and maintain the tools and infrastructure that make it all possible

#python #codeberg #readthedocs #git #magit #emacs #gnu #linux

Also migrated my `mvdate` package to Codeberg, moved docs to mkdocs and hosted them on readthedocs.org

Need to release to PyPI on the off chance someone might find it useful.

https://codeberg.org/slackline/mvdate/
https://mvdate.readthedocs.io/en/latest/

Again thanks to those who write and maintain the tools and infrastructure that make it all possible

#python #codeberg #readthedocs #git #magit #emacs #gnu #linux

Genuine question in my journey to adapt to the #python ecosystem: why did projects stop defaulting to #readthedocs for documentation?

In my memory, it was the standard a decade ago and, while it was not great, it was a consistent experience for library users. Now, most libraries either have their own website that I have to learn to navigate, or they just have a README.md.

Have there been any effort to bring an equivalent of https://pkg.go.dev or https://docs.rs to the Python ecosystem?

#TreeTime #Trees #MindMap #Editor #OpenSource #FreeSoftware

In reaction to several turns of recent events, TreeTime is starting to move away from #GitHub to #Codeberg: https://codeberg.org/jkanev/treetime#readme

There will be a transition period in which both repositories will receive updates in parallel.

The installable packages in #Pypi, the webpage on https://tree-time.info, and the documentation in #readthedocs will stay unaffected.

#TreeTime #Trees #MindMap #Editor #OpenSource #FreeSoftware

In reaction to several turns of recent events, TreeTime is starting to move away from #GitHub to #Codeberg: https://codeberg.org/jkanev/treetime#readme

There will be a transition period in which both repositories will receive updates in parallel.

The installable packages in #Pypi, the webpage on https://tree-time.info, and the documentation in #readthedocs will stay unaffected.

#TreeTime #Trees #MindMap #Editor #OpenSource #FreeSoftware

In reaction to several turns of recent events, TreeTime is starting to move away from #GitHub to #Codeberg: https://codeberg.org/jkanev/treetime#readme

There will be a transition period in which both repositories will receive updates in parallel.

The installable packages in #Pypi, the webpage on https://tree-time.info, and the documentation in #readthedocs will stay unaffected.

#TreeTime #Trees #MindMap #Editor #OpenSource #FreeSoftware

In reaction to several turns of recent events, TreeTime is starting to move away from #GitHub to #Codeberg: https://codeberg.org/jkanev/treetime#readme

There will be a transition period in which both repositories will receive updates in parallel.

The installable packages in #Pypi, the webpage on https://tree-time.info, and the documentation in #readthedocs will stay unaffected.

Late last week, I dusted off a project that had been abandoned by one of our drive-by volunteers about three years ago.

I was strugglin' a bit getting the dependency restraints updated and re-familiarizing myself with the repo and publishing configurations. I think that's in good shape now & I can mostly focus on document conversion & layout.

Now that I've got more familiarity with #Sphinx and #pandoc than I did three years ago, I looking forward to making some progress this week.

It's been a long time itch to scratch of mine & now I've got some time & motivation. We shall see....

#Xfce #Documentation #ReadTheDocs

Late last week, I dusted off a project that had been abandoned by one of our drive-by volunteers about three years ago.

I was strugglin' a bit getting the dependency restraints updated and re-familiarizing myself with the repo and publishing configurations. I think that's in good shape now & I can mostly focus on document conversion & layout.

Now that I've got more familiarity with #Sphinx and #pandoc than I did three years ago, I looking forward to making some progress this week.

It's been a long time itch to scratch of mine & now I've got some time & motivation. We shall see....

#Xfce #Documentation #ReadTheDocs

Late last week, I dusted off a project that had been abandoned by one of our drive-by volunteers about three years ago.

I was strugglin' a bit getting the dependency restraints updated and re-familiarizing myself with the repo and publishing configurations. I think that's in good shape now & I can mostly focus on document conversion & layout.

Now that I've got more familiarity with #Sphinx and #pandoc than I did three years ago, I looking forward to making some progress this week.

It's been a long time itch to scratch of mine & now I've got some time & motivation. We shall see....

#Xfce #Documentation #ReadTheDocs