Five kinds of documentation, one tool
Pick a type above- Comments & docstrings — your complete code returned with documentation added, in the docstring style you choose (Google, NumPy, reST/Sphinx, JSDoc, Javadoc, Doxygen, XML doc comments) or your language's default.
- README.md — what the project does, features, installation, usage with real examples from your code.
- API reference — every public class, function and constant: signatures, parameters, returns, errors, examples.
- Architecture overview — components, responsibilities and data flow, with a Mermaid diagram.
- Usage guide — a step-by-step tutorial for new users of your code.