3 ms·
I'm in the middle of converting a project's legacy plaintext documentation (emulating man page format) into RST/Sphinx. The support for semantic markup with rol
by abathur 10y ago
I'm in the middle of converting a project's legacy plaintext documentation (emulating man page format) into RST/Sphinx. The support for semantic markup with roles and directives was attractive for my goals (without falling down the rabbit hole, being able to: 1. translate from one source to formats compatible with both presentation-markup and semantic-markup, and 2. lint the docs).
I've come to rue this decision in some ways. I like what I've been able to accomplish, but I've found most customization of default Sphinx and docutils behavior to be torture. I don't mean to drag contributors to those projects through the mud--they work well if you can just write documentation without fiddling much.