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.2.1.tar.gz
(8.6 kB
view hashes)