Minimalistic Python documentation for dendrophiles.
treedoc prints minimalistic Python documentation in a tree structure, aiming to hit the sweet spot between detailed information about a single object and superficial information about object attributes.
treedoc is great for:
- Getting an overview of a package without endlessly scrolling through a website.
- Searching through documentation.
- Printing essential information about different Python objects.
Install from Python Package Index (PyPI) using pip install treedoc
.
treedoc can be used directly through the command-line interface,
or interactively in a Python shell or Jupyter notebook. For more information
about arguments, see treedoc --help
or help(treedoc)
.
treedoc can be imported and used just like any other package, e.g. in an interactive Python interpreter session or a Jupyter notebook.
Contributions are welcome. If you wish to work on a problem, please create a pull request to get feedback. We aim for:
- Zero dependencies, but dependencies for testing are ok.
- Idiomatic, clean Python code. Readability matters.
- Thorough testing and code formatting, see
.travis.yml
for commands run by continuous integration.