4 ms·
Yep, I tend to agree with the author. For software documentation with complex APIs, something more robust than markdown is necessary. For the same reason that
by shawnee_ 11y ago
Yep, I tend to agree with the author. For software documentation with complex APIs, something more robust than markdown is necessary. For the same reason that writing extensive in-line HTML+CSS markup is bad, relying too heavily on HTML as the "fallback" for styling and structuring things that markdown cannot handle is just not efficient.
Here's a quick cheat sheet... for the "why" of semantic styling your docs with something like .rst with directives makes for better overall integration.
https://github.com/indie/sphinx-deco/blob/master/sphinx_deco.rst https://github.com/indie/sphinx-deco/blob/master/sphinx_deco...