2 ms·
Sorry, but no. Documentation should be small, portable and easy to read on any device, even if you don't have a graphical interface. Hence the reason why markdo
by axegon_ 7y ago
Sorry, but no. Documentation should be small, portable and easy to read on any device, even if you don't have a graphical interface. Hence the reason why markdown succeeded. It is meant to be simple to learn, simple to write, simple to understand. And you can teach a non-tech person how to use it in a matter of 15 minutes. And it is nearly perfect for wikis.
That is no to say that in some cases you may find it lacking. I have and in those cases I always resort to restructuredtext. My biggest argument in favour of restructuredtext is the scikit-lerarn documentation. It covers a variety of complex topics and everything has come out perfect. Annoyingly it hasn't been very successful outside the python world but as an example I am currently using it for documentation on a project which(for the time being at least) won't include any python code.