Multidoc

Multidoc is a tool for purposed towards improving maintainability and consistency of docstrings in software that is available across multiple programming languages, with fixed language equivalent APIs.

Functions

https://numpydoc.readthedocs.io/en/latest/format.html#sections

Classes

Use the same sections as outlined above (all except Returns are applicable). The constructor (__init__) should also be documented here, the Parameters section of the docstring details the constructor’s parameters.

Constants

1. summary
2. extended summary (optional)
3. see also (optional)
4. references (optional)
5. examples (optional)

Modules

1. summary
2. extended summary
3. routine listings
4. see also
5. notes
6. references
7. examples