Docspec is a JSON object specification for representing API documentation of programming languages.
Project description
docspec
This Python packages provides
- A library to (de-) serialize Docspec conformat JSON payloads
- A CLI to validate and introspect such payloads
Example:
import docspec, sys
for module in docspec.load_modules(sys.stdin):
module.members = [member for member in module.members if member.docstring]
docspec.dump_module(sys.stdout)
$ docspec module.json --dump-tree
module docspec
| class Location
| | data filename
| | data lineno
| class Decoration
| | data name
# ...
The docspec
Python module requires Python 3.5 or newer.
Copyright © 2020, Niklas Rosenstein
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docspec-2.0.0a1.tar.gz
(8.5 kB
view hashes)
Built Distribution
Close
Hashes for docspec-2.0.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f044ded1d4a792722ca0bc2be0a823544c903a3364e65934a985d0992dd16f0 |
|
MD5 | 58642b6a64fab99e4bcf1de214d09c73 |
|
BLAKE2b-256 | 13b2e1c85d25d1ce802120ebdde421b6b15ac700bfc536cebefec77425d68988 |