Skip to main content

Minimalistic Python documentation for dendrophiles.

Project description

Build Status PyPI version Downloads Black License: MIT

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.

Installation

Install from Python Package Index (PyPI) using pip install treedoc.

Usage

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).

Command-line interface

Example 1 - See the GitHub repo

Example 2 - See the GitHub repo

Example 3 - See the GitHub repo

Python shell and notebooks

treedoc can be imported and used just like any other package, e.g. in an interactive Python interpreter session or a Jupyter notebook.

Interpreter

Example 4 - See the GitHub repo

Jupyter notebook

Example 5 - See the GitHub repo

Contributing

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for treedoc, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size treedoc-1.0.0-py3-none-any.whl (20.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size treedoc-1.0.0.tar.gz (17.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page