Docspec is a JSON object specification for representing API documentation of programming languages.
Project Links
Meta
Author: Niklas Rosenstein
Requires Python: >=3.8
Classifiers
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
2.2.2
May 06, 2025
2.2.1
May 28, 2023
2.2.0
May 28, 2023
2.1.2
Mar 15, 2023
2.0.2
Jul 18, 2022
2.0.1
Mar 24, 2022
2.0.0
Feb 27, 2022
2.0.0a1
Feb 23, 2022
1.3.0
Feb 23, 2022
1.2.0
Sep 23, 2021
1.1.0
Aug 26, 2021
1.0.1
Jul 22, 2021
1.0.0
Jul 21, 2021
0.2.1
Feb 21, 2021
0.2.0
Jul 06, 2020
0.1.0
Jun 11, 2020
0.0.5
May 24, 2020
0.0.4
May 24, 2020
0.0.3
May 24, 2020
0.0.2
May 19, 2020
0.0.1
May 18, 2020
