Project: docspec

Docspec is a JSON object specification for representing API documentation of programming languages.

Project Details

Latest version
2.2.1
Home Page
https://github.com/NiklasRosenstein/docspec/
PyPI Page
https://pypi.org/project/docspec/

Project Popularity

PageRank
0.00309538925137569
Number of downloads
46065

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