Metadata-Version: 1.1
Name: docgen
Version: 0.1.1
Summary: A markdown documentation generator for Python
Home-page: https://bitbucket.org/bkvaluemeal/docgen
Author: Justin Willis
Author-email: sirJustin.Willis@gmail.com
License: ISC License
Description: Docgen is a Python module that generates markdown documentation for Python code that adheres to Google's style guide.
        
        Install
        -------
        
        ::
        
        	pip install docgen
        
        Usage
        -----
        
        ::
        
        	$ docgen -h
        	usage: docgen [-h] [-v] [package]
        
        	docgen v0.1.1
        
        	positional arguments:
        	  package        the name of the package in the current directory
        
        	optional arguments:
        	  -h, --help     show this help message and exit
        	  -v, --version  show program's version number and exit
        
        	Copyright (c) 2017, Justin Willis
        
        	$ docgen
        	Generating documentation for package docgen:
        
        	docgen.types
        	docgen.util
        
        	/home/bkvaluemeal/Documents/docgen/docs
        
        License
        -------
        
        ::
        
        	Copyright (c) 2017, Justin Willis
        
        	Permission to use, copy, modify, and/or distribute this software for any
        	purpose with or without fee is hereby granted, provided that the above
        	copyright notice and this permission notice appear in all copies.
        
        	THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        	WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        	MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        	ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        	WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        	ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        	OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
        
Keywords: markdown documentation generator
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
