Let's try this: Dear #lazyweb / #lazyfedi, what is the current go-to if I have to/want to write application #documentation for #endusers?
It is a #rust application, that does contain a lot of #rustdoc already, but that is very specific to the code, like api/developers doc. It is not end user stuff.

So, what to do? Own branch and something in it, that then gets rendered on a Github-or-similar page? A .md file used with #mkdocs? Using #readthedocs and their #sphinx based setup (also their examples are pretty python related).

I would like to stay as near to the code as I can. *Ideally* it would be rustdoc comments, but that can't be, as that is used for the developers doc already. "Just" a file besides, maybe in doc/ sounds better than whole new branch?

Any #suggestions?

#Paramiko's #GitHub repo now has a handful of fancy issue submission templates, courtesy of @btskinn ! 😤🙌🏻✨

Be interesting to see (or…hear about… 🙈😩) if this helps a bit with some of the noisier input.

It must be administrivia day, because I've also spent some time futzing with #ReadTheDocs to see if I can get the "you're not reading the latest version” banners to show up again for my projects. (sadly not yet, even tho I nuked my old tag-versions w/ their API.)

#Documentation #WriteTheDocs #ReadTheDocs #Python #Django #Sphinx #furo

#Awesome project of the month (2023-07)

- https://blog.readthedocs.com/newsletter-july-2023/

- https://docs.django-cms.org/en/latest/

We are adding new entries to the list of Awesome Read the Docs Projects 🕶️ (https://github.com/readthedocs-examples/awesome-read-the-docs).

- https://github.com/readthedocs-examples/awesome-read-the-docs/commits.atom

Feel free to open an issue or pull request if you’ve seen something that might inspire others.

This month’s addition is the developer documentation for django-cms (https://docs.django-cms.org/en/latest/), which is noted for being both extremely extensive and well-organized at the same time.

It uses the Furo (https://pradyunsg.me/furo/quickstart/) theme that has full integration with Read the Docs’ reader extensions.

sphinx_rtd_theme tak bardzo zwleka ze wsparciem #Sphinx 7 support, że wiara aktywnie szuka alternatywy.

A myślałem, że to tylko użytkownicy #Gentoo cierpią (bo muszą instalować starszą wersję Sphinksa).

https://github.com/readthedocs/sphinx_rtd_theme/issues/1463

#ReadTheDocs #Python

sphinx_rtd_theme is slacking on adding #Sphinx 7 support to the point that people are actively seeking another theme.

And I thought that it is annoying for #Gentoo users (who have to downgrade their system Sphinx) only.

https://github.com/readthedocs/sphinx_rtd_theme/issues/1463

#ReadTheDocs #Python

@hertog yeah...

It also added 0 value to me compared to #ReadTheDocs.io, #IRC, #Mumble, #Zulip & #JitsiMeet...

Does anyone know of a Sphinx extension that shows commands to be executed (in a console) where example output of this command can be expanded/collapsed?
Sounds like a common problem for which a ready-made solution is likely to exist.
My current solution is using https://sphinx-design.readthedocs.io/en/latest/dropdowns.html for the example output part but it's all a bit clunky.

#sphinx #sphinx-doc #readthedocs #rtfd

Huh. #SVG on #Sphinx works when viewing the documentation locally, but not when viewing it on #ReadTheDocs...

010 - Make and Read the docs by Alix Chagué: https://alix-tz.github.io/phd/posts/010/
#markdown #eScriptorium #Readthedocs #dh

Academics opting to write statistical software documentation in pdfs only rather than html/markdown is holding back the adoption of social scientific methods for #DataScience

For #Rstats, use #pkgdown: https://pkgdown.r-lib.org/

For #PyData, use #sphinx / #readthedocs : https://sphinx-book-theme.readthedocs.io/en/stable/

#socialscience

@choldgraf @readthedocs Yes, #ReadTheDocs gives some basic analytics, I'm not sure where it comes from but I assumed it was web server logs. Screenshots attached that show what I see - it doesn't include region but would be enough for basic metrics.

Looking up something & found this post again about using #Ruby hashes better and was reminded of this dead simple 1-line cache (yes, it doesn't clear the entries, etc.) built using default procs for the hash. This, and more at:

https://notepad.onghu.com/2022/ruby-tips-011-level-up-your-use-of-ruby-hash-1/

#programming #ReadTheDocs

We really need to give more credit to NXP for creating tools like SPSDK in Python, available through #PyPI, with source on #GitHub, and documentation on #readthedocs. Their MCUXpresso SDK is also available on GitHub.

If for no other reason, to shame other vendors into following their lead. Am I wrong?

https://spsdk.readthedocs.io/en/latest/

#Sphinx #ReadTheDocs
Do you like the `sphinx_rtd_theme` ?
Yes? No? Why?

#python #sphinx #readthedocs #documentation

- https://blog.readthedocs.com/newsletter-january-2023/

Here are the latest updates from our team since the previous newsletter:

📹️ Eric delivered a talk at DjangoCon US 2022 with practical tips for developing state of the art documentation projects. You can watch it here: Documenting Django Code in 2022

🛠️ In line with the talk, we continued reorganizing our own documentation to follow the Diátaxis Framework.

🚢️ Sphinx 6.0 and 6.1 have been released. If you want things to not break, it’s good to wait a bit. Read our considerations for upgrading.

🔒️ We fixed a security vulnerability on our platform. See: GHSA-368m-86q9-m99w

🔒 We immediately rotated Circle CI secrets as advised by Circle CI. Read the Docs did not share secrets with Circle CI for build infrastructure, nor do we see any signs that other secrets have been suspiciously accessed.

You can always see the latest changes to our platforms in our Read the Docs Changelog.

#python #sphinx #readthedocs #documentation

Here are the latest updates from our team since the previous newsletter:

📹️ Eric delivered a talk at DjangoCon US 2022 with practical tips for developing state of the art documentation projects. You can watch it here: Documenting Django Code in 2022

🛠️ In line with the talk, we continued reorganizing our own documentation to follow the Diátaxis Framework.

🚢️ Sphinx 6.0 and 6.1 have been released. If you want things to not break, it’s good to wait a bit. Read our considerations for upgrading.

🔒️ We fixed a security vulnerability on our platform. See: GHSA-368m-86q9-m99w

🔒 We immediately rotated Circle CI secrets as advised by Circle CI. Read the Docs did not share secrets with Circle CI for build infrastructure, nor do we see any signs that other secrets have been suspiciously accessed.

You can always see the latest changes to our platforms in our Read the Docs Changelog.

@akien Is this the right documentation for the current beta 10?

https://docs.godotengine.org/en/latest/

I just changed 'stable' in the URL to 'latest'. IIRC the main branch is where v4 is being pushed.

#GodotEngine #ReadTheDocs

Just as a heads up for those that use #ReadTheDocs and have pinned the Pallets-Sphinx-Themes package to a specific version, you might want to update your pin to use 2.0.3 due to build issues with the Read The Docs pipeline.

A new version of the theme hasn't been published to GitHub, but it has been published on to #PyPi.

#Python #Sphinx

#Emacs #OrgMode + #ReadTheOrg (#ReadTheDocs css) + #CodebergPages = ❤️

@Codeberg

@tyil @gamingonlinux

the worst part of any #community #chat system is that unlike classical #forum|s, you can't search shit.

It's not like #ReadTheDocs or a #phpBB or even the toxic cesspool that is #StackOverflow / #ServerFault that it's searchable.

Creating a gazillion of redundant questions where one can't even link to answers...