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 details)

Uploaded Python 3

File details

Details for the file pydocless-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pydocless-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for pydocless-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 941d59d15fae7b5e9190045565db34baa2f9a65e7648c00aaa5b606929d79b15
MD5 e4fa6268e9b0d081755f252e9e707bf4
BLAKE2b-256 ede446b5fe7527781f1b69c41db39e77090c656bd694466d6abbb8d4066801f3

See more details on using hashes here.

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