Metadata-Version: 1.1
Name: pydoc-markdown
Version: 0.1.0
Summary: Create Python API documentation in Markdown format
Home-page: https://github.com/NiklasRosenstein/pydoc-markdown
Author: Niklas Rosenstein
Author-email: rosensteinniklas@gmail.com>
License: MIT
Description: __NAME__ 

        <a href="https://gitter.im/NiklasRosenstein/pydoc-markdown">

          <img href="https://badges.gitter.im/Join%20Chat.svg"></img>

        </a>

        

        `pydoc_markdown` - simple generator for Markdown formatted Python docs

        

        

        __SYNOPSIS__

        

            pydoc-markdown [-h] module

        

        __DESCRIPTION__

        

        Simple (ie. quick and dirty) script to generate a Markdown

        formatted help on a Python module. Contributions are welcome.

        

        Project Homepage:  https://github.com/NiklasRosenstein/pydoc-markdown

        

        ```

        positional arguments:

          module      name of the module to generate docs for

        

        optional arguments:

          -h, --help  show this help message and exit

        ```

        

        __INSTALLATION__

        

            $ pip install pydoc-markdown

        

        or for the latest development version

        

            $ git clone https://github.com/NiklasRosenstein/pydoc-markdown

            $ cd pydoc-markdown

            $ pip install -e .

        

        __EXAMPLES__

        

            $ pydoc-markdown glob

        

            # glob Module

            > Filename globbing utility.

        

        

        

            ## Data

            - `magic_check = re.compile('([*?[])')`

            - `magic_check_bytes = re.compile(b'([*?[])')`

        

            ## Functions

        

            ##### `escape(pathname)`

        

            > Escape all special characters.

        

        

        

            ##### `glob(pathname)`

        

            > Return a list of paths matching a pathname pattern.

            >

            >     The pattern may contain simple shell-style wildcards a la

            >     fnmatch. However, unlike fnmatch, filenames starting with a

            >     dot are special cases that are not matched by '*' and '?'

            >     patterns.

        

        

        

            ##### `glob0(dirname, basename)`

        

        

        

            ##### `glob1(dirname, pattern)`

        

        

        

            ##### `has_magic(s)`

        

        

        

            ##### `iglob(pathname)`

        

            > Return an iterator which yields the paths matching a pathname pattern.

            >

            >     The pattern may contain simple shell-style wildcards a la

            >     fnmatch. However, unlike fnmatch, filenames starting with a

            >     dot are special cases that are not matched by '*' and '?'

            >     patterns.

        
Keywords: markdown pydoc generator docs documentation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
