I have asked #GPT-4.0 to translate a news report from Dutch to German for me because I wanted to inform my family about current debates in the Netherlands. I was surprised that #ChatGPT started a #deepsearch although I had not actively selected this feature. I had vaguely heard about it but never used it before, and I am still wondering what it actually does. I will have to #readthedocs for sure! But has anyone got insights they'd like to share? Deep search sounds a lot like #energywaste to me.
About 2 or 3 years ago, I had some brave soul step up and volunteer to convert the #Xfce #documentation over to the .rst format to publish to #readthedocs
I was busy at the time; but, I went ahead and set up the initial repos & created the workflow that would allow them to publish the docs on the platform.
IIRC, they lasted several weeks and a handful of docs before they disappeared.
It's definitely not glamorous work.
@baldur actually, #LLMs ingesting masses of #OpenSource documentation and then emitting polished and credible seeming mashups with spurious and misleading content is **exactly** what we don't need just now, so I hope #ReadTheDocs will change their policy and just block these bloody things altogether.
@awoodsnet It’s hosted on #ReadTheDocs, using their docs template and Sphinx to generate them.
The README in my docs folder goes into more detail: https://github.com/ramsey/uuid/tree/4.x/docs
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). Somehting else?
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? Also, would be nice if I do NOT have to learn a complete new markup language.
Any #suggestions?
Part 10: Turns out yesterday was a Reading Day. I have the libraries up and running, but it’s time to truly get the picture as to why USD is even a thing, and what made Apple choose it. A lot of the existing literature is for VFX folks, which I am not, so in addition to my Top Pick references there’s some added color for programmers.
https://www.whynotestflight.com/excuses/hello-usd-part-10-reading-day/
If you watch nothing else (39 min): https://www.nvidia.com/en-us/on-demand/session/gtcspring23-s52054/
@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.
Last Friday of the month, new release of #ipython. Soon on conda. Some #readthedocs issues to build the latest what's new, so no link to it (yet), but have a look at https://github.com/ipython/ipython/milestone/111?closed=1 and https://github.com/ipython/ipython/pull/13888 from @krassowski . Also big thanks to the D.E. Shaw group for the improvement suggestions, and funding work on IPython.
@TedUnderwood Thanks for the tip!
Information on favorites being full-text searchable is right in the search documentation if I had bothered to read it.
I believe you can see if your Mastodon instance has enabled full-text searching of your own posts & favorites by clicking in the search box in the Web interface and reading what's there.
This is what I see on #fosstodon #FediTips #ReadTheDocs
Our tip of the month 
is "sphinx-timeline" written by Chris Sewell:
Use this new extension to add milestones, organization history, roadmaps or any other timelines to your documentation project.
Read more on sphinx-timeline's documentation at 
https://sphinx-timeline.readthedocs.io/
The OmegaT project now has a developer contribution guide on Read the Docs:
https://omegat.readthedocs.io/
or
Check it out if you are thinking about making a developer contribution to #OmegaT.
Hello Fediverse 
. We have created an account on Fosstodon 
to talk about #documentation 
with you all! We'll also post updates about #readthedocs 
and #writethedocs 
How is the #readthedocs and #writethedocs community here in Mastodon? Hi you all 
glad that identityserver develop group so thoughtful just pass those RANDOMSTRING as ERROR description that shows no FUCKING USEFUL INFORMATION for people trying to set things up and just reply #readthedocs on github issue page fuck.
Documentation is crucial in any software project, but often neglected. Here is a nice introduction to the great tools available when using Python:
https://www.pythonforthelab.com/blog/documenting-with-sphinx-and-readthedocs/
