Metadata-Version: 2.1
Name: docmd
Version: 1.0.1
Summary: Convert python docstring documentation to github markdown files
Home-page: UNKNOWN
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown

# docmd

Generate api-style github markdown-files from python docstrings.

Generate one file:

```
docmd my_module > README.md
```

Generate a whole folder full of documentation:

```
docmd my_module -out docs -url https://github.com/atakamallc/docmd/blob/master
```



# [docmd](#docmd).docmd

Using docmd from python.

Example:

```
    from docmd import DocMd

    d = DocMd()
    mod = d.importlib("module")
    d.module_gen(mod)
```



## DocMd(object)
Generator class for producing md files.


#### .__init__(self, output_dir=None, source_url=None, output_fh=None)
Construct a DocMd object:

Args:
 - output_dir: folder to write files to (optional)
 - source_url: url for making source links
 - output_fh: file handle to use if no output_dir is specified (sys.stdout)


#### .import_module(name)
Wrapper for importlib, in case we want to support more ways of specifying a module.

#### .module_gen(self, mod:module) -> str
Generate markdown, given an imported module with docstring comments.

Returns: name of the module generated.





