https://github.com/niklasrosenstein/python-docspec

Docspec is a JSON object specification for representing API documentation of programming languages.
https://github.com/niklasrosenstein/python-docspec

api-documentation library python specification

Last synced: about 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/niklasrosenstein/python-docspec
• Owner: NiklasRosenstein
• License: other
• Created: 2020-05-18T00:24:28.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-12-03T16:15:40.000Z (over 1 year ago)
• Last Synced: 2025-04-28T15:53:36.443Z (about 1 year ago)
• Topics: api-documentation, library, python, specification
• Language: Python
• Homepage: https://niklasrosenstein.github.io/python-docspec/
• Size: 7.18 MB
• Stars: 16
• Watchers: 3
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
> 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 📃](https://niklasrosenstein.github.io/python-docspec/specification/)

### docspec-python

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

[→ View the Documentation 📘](https://niklasrosenstein.github.io/python-docspec/api/docspec-python/)

## Projects using `docspec`

* [Pydoc-Markdown](https://github.com/NiklasRosenstein/pydoc-markdown) – The original spark for Docspec.

---

Copyright © 2021, Niklas Rosenstein