Skip to main content
# 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
}
```



Metadata

Release files for pydocless 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for pydocless 0.0.2
File Interpreter ABI Platform
pydocless-0.0.2-py3-none-any.whl Python 3 none any Details

Release files / pydocless-0.0.2-py3-none-any.whl

Download URL pydocless-0.0.2-py3-none-any.whl
Size 3.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
941d59d15fae7b5e9190045565db34baa2f9a65e7648c00aaa5b606929d79b15
BLAKE2b-256 checksum
How to use checksums
ede446b5fe7527781f1b69c41db39e77090c656bd694466d6abbb8d4066801f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

Release history Release notifications | RSS feed

This release

0.0.2 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page