Any tips for editing #sphinx #documentation? Do you have an editor or IDE that shows changes live or other cool workflow hacks? Or at least a good cheat sheet? I'm kinda tired of spending half my time looking up rst and Sphinx syntax features.
@yakky Ah, I saw that, but then it turned out that it doesn't watch changes to your theme, and then I grew frustrated when I was changing up the look of the docs and apparently I forgot about it afterwards.
(I'm really looking for a feedback cycle of the common side-by-side markdown editors, but it seems there is nothing like that?)
@rixx I've only seen tools with side-by-side rendering for pure rst, not sphinx (it's called retext). I'm really struggling with that too :(
I'm trying to move our non technical documentation out of binary formats like libreoffice, but the lack of easy editors is really a blocker
@yakky Sphinx adds a lot of mental load for me, because I can't seem to remember linking syntax, marks, and lots of other useful stuff, and the docs for looking things up are … not great, especially since you need to figure out every time if you're looking up a sphinx feature or an rst feature.
@rixx I totally feel your pain 🤗 and I wish you good luck with your current effort going on your timeline. I will also ping some people I am working to set up a RTD environment for the tech docs for the italian government. They/we are doing a lot of research / development for tech writers (and everything is / will be open source), but I don't know the status on the "write / editor" part as I am mostly focused on the RTD infrastructure
@yakky That would be appreciated! I also pinged Write The Docs on twitter, maybe they have some helpful magic.
@rixx @yakky Just subscribing to this thread since we are at the brink of changing our setup for the https://bettercrypto.org/ project in lieu if a larger content update.
Sphinx is our prime candidate at the moment.
@MacLemon For a general collection of Sphinx ressources, I can recommend https://github.com/yoloseem/awesome-sphinxdoc
@rixx I use this https://pypi.org/project/sphinx-autobuild/ to have an updated rendering of the documentation whenever I make a change. But no real breakthrough / better workflow than that :/