{ "info": { "author": "Dave Shawley", "author_email": "daveshawley+python@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4" ], "description": "\nSphinx JSON Domain\n==================\n\n.. image:: https://img.shields.io/pypi/v/sphinx-jsondomain.svg?maxAge=2592000\n :target: https://pypi.python.org/pypi/sphinx-jsondomain\n.. image:: https://readthedocs.org/projects/sphinx-jsondomain/badge/?version=latest\n :target: http://sphinx-jsondomain.readthedocs.io/en/latest/?badge=latest\n.. image:: https://travis-ci.org/dave-shawley/sphinx-jsondomain.svg?branch=master\n :target: https://travis-ci.org/dave-shawley/sphinx-jsondomain\n\nI was surprised that this didn't already exist somewhere when I wanted to\ndescribe a JSON document outside of using `sphinxcontrib-httpdomain`_ to\ndocument one of my APIs. This extension simplifies describing structured\nJSON documents using a new `Sphinx domain`_.\n\n.. code-block:: rst\n\n .. json:object:: Github User\n\n What Github's API thinks a user looks like.\n\n :property string login: the user's login\n :property integer id: Github assigned unique user identifier\n :property string avatar_url: url to user's selected avatar image\n or the empty string\n :property string gravatar_url: url to the user's gravatar image\n or the empty string\n\nThis will format to something pretty and make references to\n`:json:object:`Github User`` work as expected. See the `online examples`_\nfor a better idea of what is possible.\n\nQuick Start\n-----------\nInstall sphinx and the ``sphinx-jsondomain`` package::\n\n $ python3 -mvenv env\n $ env/bin/pip install -q sphinx sphinx-jsondomain\n\nSet up the sphinx documentation root and build your documentation set::\n\n $ env/bin/sphinx-quickstart -p my-project -r 0.0 -v 0.0.0 \\\n > -a 'Dave Shawley ' --quiet docs\n $ env/bin/sphinx-build -b html docs build/sphinx/html\n\nNow, find the ``extensions`` definition in *docs/conf.py* and add\n``sphinxjsondomain`` to the end. Add a ``json:object`` directive to\n*docs/index.rst* and run *sphinx-build* again to see the results.\n\n.. _sphinxcontrib-httpdomain: https://pythonhosted.org/sphinxcontrib-httpdomain/\n.. _sphinx domain: http://www.sphinx-doc.org/en/stable/domains.html#what-is-a-domain\n.. _online examples: https://sphinx-jsondomain.readthedocs.io/en/latest/examples.html\n\n\n", "description_content_type": null, "docs_url": "https://pythonhosted.org/sphinx-jsondomain/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dave-shawley/sphinx-jsondomain", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinx-jsondomain", "package_url": "https://pypi.org/project/sphinx-jsondomain/", "platform": "", "project_url": "https://pypi.org/project/sphinx-jsondomain/", "project_urls": { "Homepage": "https://github.com/dave-shawley/sphinx-jsondomain" }, "release_url": "https://pypi.org/project/sphinx-jsondomain/0.0.3/", "requires_dist": [ "Faker (>=0.7.18,<0.8)", "Sphinx (>=1.4,<2)" ], "requires_python": "", "summary": "Describe JSON document structures in sphinx", "version": "0.0.3" }, "last_serial": 3087653, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "389495d0074fe1b5f98a1278f7047b3d", "sha256": "e7ee9c1ca1a1e3a5f07b01f6e75d9120649ac6553eec6c96793e70470eb4baca" }, "downloads": -1, "filename": "sphinx_jsondomain-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "389495d0074fe1b5f98a1278f7047b3d", "packagetype": "bdist_wheel", "python_version": "any", "requires_python": null, "size": 8545, "upload_time": "2016-06-20T11:52:27", "url": "https://files.pythonhosted.org/packages/55/1c/cae719348375792e350e2dde81702bcfb88e4d9b544feb7b48a66e146202/sphinx_jsondomain-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c84aeeedb9ce179866b53a453f6ef820", "sha256": "07d61429f67352cf334f7c95f8159d2a085e18567a9659c03dd6d29b2b51db25" }, "downloads": -1, "filename": "sphinx-jsondomain-0.0.1.tar.gz", "has_sig": false, "md5_digest": "c84aeeedb9ce179866b53a453f6ef820", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6934, "upload_time": "2016-06-20T11:48:07", "url": "https://files.pythonhosted.org/packages/95/ff/c358d21a4ba23ffed80a50151fcb6e96246c23aeb7790d22327aff53f8eb/sphinx-jsondomain-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "f7976c1ae0017e1d0d972100d744f3eb", "sha256": "98e4214821631073363e48dcfa8235b210066d1fab22c2294f2a73fff92b6155" }, "downloads": -1, "filename": "sphinx_jsondomain-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f7976c1ae0017e1d0d972100d744f3eb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9896, "upload_time": "2016-06-22T12:04:32", "url": "https://files.pythonhosted.org/packages/7d/73/57492e375ccc447b72eedcd0ac0d11b9e42beb7300c19948306786f511ac/sphinx_jsondomain-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9447d4d8bb7f8698a71f92f933f9cf24", "sha256": "849723f3c27549630256b0b82a838f1c1e10b18b2a2dfff82287ec7f922a14a3" }, "downloads": -1, "filename": "sphinx-jsondomain-0.0.2.tar.gz", "has_sig": false, "md5_digest": "9447d4d8bb7f8698a71f92f933f9cf24", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8189, "upload_time": "2016-06-22T12:04:36", "url": "https://files.pythonhosted.org/packages/f9/99/acf6840876ce3e88569b0e57f1fa7081eeabfa110604b609c013cb986e33/sphinx-jsondomain-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "27a91f051f9a02fbb7c8872e7ae43c81", "sha256": "cdc03fa28dafc383d30451d724ea293dded4619d777acfa003b2a538bbf52f85" }, "downloads": -1, "filename": "sphinx_jsondomain-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "27a91f051f9a02fbb7c8872e7ae43c81", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9897, "upload_time": "2017-08-10T17:45:01", "url": "https://files.pythonhosted.org/packages/b0/d5/84dd6832ba3efd05abadffed03c703cf592366c89580a12af893a3cde056/sphinx_jsondomain-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "caff2b0eefce3f8689f2dcffd4988756", "sha256": "fd4688d3026bd40c8d3aea94c0ea423d32dd9a046e6dc80fba83aaf60c87abc4" }, "downloads": -1, "filename": "sphinx-jsondomain-0.0.3.tar.gz", "has_sig": false, "md5_digest": "caff2b0eefce3f8689f2dcffd4988756", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8188, "upload_time": "2017-08-10T17:45:02", "url": "https://files.pythonhosted.org/packages/6c/9c/521e9703edfb28d370d51322797d63950d099dd934b9e3f6358299559dcc/sphinx-jsondomain-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "27a91f051f9a02fbb7c8872e7ae43c81", "sha256": "cdc03fa28dafc383d30451d724ea293dded4619d777acfa003b2a538bbf52f85" }, "downloads": -1, "filename": "sphinx_jsondomain-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "27a91f051f9a02fbb7c8872e7ae43c81", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9897, "upload_time": "2017-08-10T17:45:01", "url": "https://files.pythonhosted.org/packages/b0/d5/84dd6832ba3efd05abadffed03c703cf592366c89580a12af893a3cde056/sphinx_jsondomain-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "caff2b0eefce3f8689f2dcffd4988756", "sha256": "fd4688d3026bd40c8d3aea94c0ea423d32dd9a046e6dc80fba83aaf60c87abc4" }, "downloads": -1, "filename": "sphinx-jsondomain-0.0.3.tar.gz", "has_sig": false, "md5_digest": "caff2b0eefce3f8689f2dcffd4988756", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8188, "upload_time": "2017-08-10T17:45:02", "url": "https://files.pythonhosted.org/packages/6c/9c/521e9703edfb28d370d51322797d63950d099dd934b9e3f6358299559dcc/sphinx-jsondomain-0.0.3.tar.gz" } ] }