Skip to main content

Python library for creating markdown documentation from python docstrings

Project description

# pydocless

Library for turning your python docstrings into Markdown documentation.
Note this should not be used as a substitute for good documentation, but as an addition.
The style is intended to look similar to Python's standard library API docs.

### Usage:
From the command line:
```
pydocless config.json > module_doc.md
```

Or from within a python environment:
```
from pydocless import pydocless
md_text = pydocless(config)
```

The config object should be a dictionary:
```
{
"module": "module_name", # Module should be available within the python environment
"includes": [], # List of regexes for what to include. By default nothing is included
"excludes": [] # List of regexes for what to exclude. By default everything is excluded
}
```



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pydocless-0.0.2-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page