3 ms·
A little off-topic, but as someone who's just started producing documentation in Sphinx, what are the problems/downsides that you've run in to? I've used it fo
by pokeymcsnatch 7y ago
A little off-topic, but as someone who's just started producing documentation in Sphinx, what are the problems/downsides that you've run in to?
I've used it for two projects so far: documenting a relatively small python module, and for documenting a RESTful API. I do a lot of embedded work, so I'd like to use it as a place to document a piece of hardware in it's entirety, from schematics/layouts to firmware and build toolchains to actual use of the device. Do you (or anyone else reading this) have any comments on that use case?
I think my main complaint at the moment is that it doesn't play nice with Markdown, so I had to re-format a bunch of pre-existing documentation for it to work in Sphinx. ReST seems to render alright in Gitlab though, so that's a plus.
- kfoley 7y agoSphinx should support Markdown, we're using the instructions at https://www.sphinx-doc.org/en/master/usage/markdown.html https://www.sphinx-doc.org/en/master/usage/markdown.html for our project and haven't had any issues. Haven't tried it yet but you should also be able to enable rst blocks through recommonmark so you get the best of both - https://recommonmark.readthedocs.io/en/latest/auto_structify.html#embed-restructuredtext https://recommonmark.readthedocs.io/en/latest/auto_structify...