Metadata-Version: 1.1
Name: sphinx-jsondomain
Version: 0.0.3
Summary: Describe JSON document structures in sphinx
Home-page: https://github.com/dave-shawley/sphinx-jsondomain
Author: Dave Shawley
Author-email: daveshawley+python@gmail.com
License: BSD
Description: 
        Sphinx JSON Domain
        ==================
        
        .. image:: https://img.shields.io/pypi/v/sphinx-jsondomain.svg?maxAge=2592000
           :target: https://pypi.python.org/pypi/sphinx-jsondomain
        .. image:: https://readthedocs.org/projects/sphinx-jsondomain/badge/?version=latest
           :target: http://sphinx-jsondomain.readthedocs.io/en/latest/?badge=latest
        .. image:: https://travis-ci.org/dave-shawley/sphinx-jsondomain.svg?branch=master
           :target: https://travis-ci.org/dave-shawley/sphinx-jsondomain
        
        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`_.
        
        .. code-block:: rst
        
           .. 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.  See the `online examples`_
        for a better idea of what is possible.
        
        Quick Start
        -----------
        Install sphinx and the ``sphinx-jsondomain`` package::
        
           $ python3 -mvenv env
           $ env/bin/pip install -q sphinx sphinx-jsondomain
        
        Set up the sphinx documentation root and build your documentation set::
        
           $ env/bin/sphinx-quickstart -p my-project -r 0.0 -v 0.0.0 \
           > -a 'Dave Shawley <daveshawley@gmail.com>' --quiet docs
           $ env/bin/sphinx-build -b html docs build/sphinx/html
        
        Now, find the ``extensions`` definition in *docs/conf.py* and add
        ``sphinxjsondomain`` to the end.  Add a ``json:object`` directive to
        *docs/index.rst* and run *sphinx-build* again to see the results.
        
        .. _sphinxcontrib-httpdomain: https://pythonhosted.org/sphinxcontrib-httpdomain/
        .. _sphinx domain: http://www.sphinx-doc.org/en/stable/domains.html#what-is-a-domain
        .. _online examples: https://sphinx-jsondomain.readthedocs.io/en/latest/examples.html
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Framework :: Sphinx :: Extension
