Skip to content

tunaworks/gethelp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 

Repository files navigation

gethelp

Writes module's help() as .txt files into the current directory (or wherever you want).

By default, docs will be stored in sys.path[0]/readme .

Example:

from gethelp import Helpdoc
import somemodule

Helpdoc(somemodule)

subfolders will be created if additional modules are present.

~/workspace/$ ls -R -1 readme

readme:
somemodule/

readme/somemodule:
api/
somemodule.txt
somemodule_helpers.txt

readme/somemodule/api:
somemodule_api.txt

Usage

from gethelp import Helpdoc as h
import somemodule

h(somemodule)

About

Prints a module's help docs into subdirectories

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages