I’m currently writing documentation in RST/Sphinx. Years ago, I’d written in DocBook/SGML and really liked being able to set entities for various references that I didn’t want to type out (long file names, long documentation names, references to manuals in our documentation set, etc). We’d throw something like &bdl-ug; into the doc and have it defined to output something like “Blue Dog Linux User’s Guide.”
For the life of me, I’ve not been able to figure out how to do this on the Sphinx side. It may not be possible, but I’m wondering if jinja templating can help (and how) or if there are other suggestions available.
I’m a team of one, but as our company grows, we’ll hire other writers. I want to set this up so it’s easy to use and harder to make silly mistakes/typos for common terms that shouldn’t have to be written out each and every time.
Thanks and cheers!