docspec-python

A parser based on lib2to3 producing docspec data from Python source code.


Keywords
api-documentation, library, python, specification
License
MIT
Install
pip install docspec-python==0.1.1

Documentation

Note: The GitHub repository was moved from NiklasRosenstein/docspec to NiklasRosenstein/python-docspec on May 13, 2023.

Docspec

Docspec is a JSON object specification for representing API documentation of programming languages. While in it's current form it is targeting Python APIs, it is intended to be able to represent other programming languages in the future as well

What is...?

docspec

The reference implementation for reading/writing the JSON format and API for representing API objects in memory.

→ View the Specification 📃

docspec-python

A parser for Python packages and modules based on lib2to3 producing docspec API object representations.

→ View the Documentation 📘

Projects using docspec


Copyright © 2021, Niklas Rosenstein