Describe JSON document structures in sphinx
Project description
I was surprised that this didn’t already exist somewhere when I wanted to describe a JSON document outside of using sphinxcontrib-httpdomain to document one of my APIs. This extension simplifies describing structured JSON documents using a new Sphinx domain.
.. json:object:: Github User
What Github's API thinks a user looks like.
:property string login: the user's login
:property integer id: Github assigned unique user identifier
:property string avatar_url: url to user's selected avatar image
or the empty string
:property string gravatar_url: url to the user's gravatar image
or the empty string
This will format to something pretty and make references to :json:object:`Github User` work as expected.
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
Built Distribution
Close
Hashes for sphinx_jsondomain-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7ee9c1ca1a1e3a5f07b01f6e75d9120649ac6553eec6c96793e70470eb4baca |
|
MD5 | 389495d0074fe1b5f98a1278f7047b3d |
|
BLAKE2b-256 | 551ccae719348375792e350e2dde81702bcfb88e4d9b544feb7b48a66e146202 |