This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project 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.
Release History

Release History

0.1.0

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pydoc-markdown-0.1.0.zip (12.1 kB) Copy SHA256 Checksum SHA256 Source Apr 4, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting