Code API reference¶
External documentation is not the place where to maintain code API reference. Code should be self-documented.
It doesn’t mean documentation cannot deal with API: it is a suitable place to provide tutorials or recipes, to focus on topics or workflows... It means that external documentation is not intended to replace inline code documentation.
As an example, Sphinx [1] users can generate API reference from code then include it to Sphinx documentation with Sphinx’s autodoc extension [2].