tadaboody / doctree Goto Github PK

Setting max_depth=3 in this project gives some icky results.

If a dir is a python package i.e. it has an __init__.py__ file, The docstring of __init__.py should be used as a doc

Right now it's unreadable

Your issue may already be reported!
Please search on the issue track before creating one.

Expected Behavior

Updating the README to reflect the current output should be easy to install and use

Current Behavior

You need to manually run an install script which adds a pre-commit hook and you need to know to write to base_README.md

Possible Solution

Use Travis

Steps to Reproduce (for bugs)

If a defines nothing but a class, the classes documentation should be used as the module doc

The pathlib module introduced in py3.5 is a cleaner, more object oriented way to handle system paths.
It eliminates the need to pass around contexts and full paths

This will let people easily insert it into the docs, re-running it every time they re-run the docs

It'll make ignoring gitignore and project traversal infinitely simpler