{
    "info": {
        "author": "Jeremy Bowman",
        "author_email": "jbowman@safaribooksonline.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "sbo-sphinx README\n=================\n\nOverview\n--------\n\nSafari technical documentation is now being written and collected\nin a form that can be processed by `Sphinx <http://sphinx-doc.org/>`_, a utility\nfor generating documentation in HTML, PDF, Epub, and other formats from text\nfiles using reST (reStructuredText) wiki markup.  In addition to writing docs\ndirectly, we can have Sphinx grab API documentation from our core\nprogramming languages:\n\n* Python docstrings are collected using the sphinx-apidoc command.\n* JSDoc-formatted comments in JavaScript are collected using the\n  JsDoc Toolkit RST-Template library, which in turn uses jsdoc-toolkit.\n\nWeb service APIs can be documented using httpdomain from sphinx-contrib.\n\nInstallation\n------------\n``pip install sbo-sphinx``\n\nTo build JavaScript API documentation, you'll also need java and ant.\n\nSettings\n--------\nsbo-sphinx uses the standard Sphinx `conf.py file <http://sphinx-doc.org/config.html>`_,\nbut offloads the vast majority of the configuration to an\n``sbo_sphinx.conf`` module which should be appropriate for most SBO\nprojects.  Hence a minimal ``docs/conf.py`` file can be as simple as::\n\n    from sbo_sphinx.conf import *\n\n    project = 'my_project_name'\n\nThere should also be a ``docs/index.rst`` file to serve as the documentation\nhome page; see the one in this project for an example.\n\nThere are additional settings for the extensions which auto-generate Python\nand JavaScript API documentation. See ``sbo_sphinx.apidoc`` and\n``sbo_sphinx.jsdoc`` for details.\n\nUsage\n-----\nUse the standard `sphinx-build <http://sphinx-doc.org/invocation.html>`_ syntax.\nFor the usual case of wanting to generate the documentation in HTML format:\n\n.. code-block:: sh\n\n    sphinx-build -b html . _build\n\nExternal Files\n--------------\nreStructuredText not inside the ``docs`` directory hierarchy can't be directly\nincluded in a table of contents.  To include a README.rst file from the\nrepository's root directory in the generated documentation, create a\nplaceholder inside the ``docs`` directory which uses an include directive to\npull in its content:\n\n    ``.. include:: ../README.rst``\n\nFor an example, see ``docs/readme.rst`` in this project.\n\nPyPI Description Validation\n---------------------------\nIf PyPI encounters something it doesn't know how to handle in a reStructuredText\npackage description, it just silently shows it as plain text instead of\nformatting it as expected.  To get some warning of this before uploading your\npackage, install the ``readme`` package and run::\n\n    python setup.py check --restructuredtext --strict\n\nNote that for this to work, long_description must be set in setup.py\n(usually by loading it from a README.rst file or such).  If you instead\ncount on setting ``description-file`` in ``setup.cfg``, the reStructuredText\nthat will be used for the PyPI page isn't available to the ``check`` command.\n\nMarkdown\n--------\nSphinx currently has no real support for Markdown-style wiki markup.  If a\nproject has a README.md which you want to include in the documentation, there\nare a few options:\n\n* Convert it to README.rst instead, changing the markup accordingly.\n  `pandoc <http://johnmacfarlane.net/pandoc/>`_ may do a reasonably good job\n  of automating this conversion.\n* Add a reStructuredText-formatted copy of the file to the ``docs`` directory\n  and include that in the documentation instead.  This does run the risk of\n  the copy getting out of sync with the original, however.\n* Implement a Sphinx extension which uses pandoc to automatically convert and\n  copy the Markdown files specified in a configured list.  The drawback with\n  this approach is that it requires pandoc to be installed on each system on\n  which the documentation will be generated.\n\nRead the Docs\n-------------\nsbo-sphinx was written to be mostly compatible with the\n`Read the Docs <https://readthedocs.org/>`_ service, but keep in mind that\nprivate source code repositories cannot be used on the public Read the Docs\nservice (but can be on a suitably configured private installation).\n\nNotes\n-----\n* The table of contents page for Python modules is generated at\n  ``docs/python/index``.  The equivalent file for JavaScript (if generated)\n  is at ``docs/javascript/index``, and there is also a list of processed JS\n  files at ``docs/javascript/files``.  These should be added to a toctree\n  directive in the documentation.  Again, see this project's ``docs/index.rst``\n  for an example.\n* The RST-Template library for creating reST files from JSDoc comments\n  currently uses jsdoc-toolkit, which is no longer in active development.  If\n  we decide that its successor JSDoc 3 has enough useful improvements, we can\n  look into updating the library to use that instead.\n\nTroubleshooting\n---------------\n* *error: unrecognized arguments* - If this pops up and breaks the build while\n  parsing the code being documented, odds are that file has code at the module\n  level which uses ``argparse`` or ``optparse``, and it's unsuccessfully trying\n  to parse the command line parameters which were given to sphinx-build.  Put\n  such code inside a function which is only called inside an\n  ``if __name__ == '__main__'`` condition (i.e., if that script was the one\n  called).\n\nReferences\n----------\n\n* `Sphinx <http://sphinx-doc.org/>`_\n* `reStructuredText syntax overview <http://docutils.sourceforge.net/docs/user/rst/quickstart.html>`_\n* `JSDoc <http://code.google.com/p/jsdoc-toolkit/>`_\n* `JSDoc 3 <http://usejsdoc.org/index.html>`_\n* `JsDoc Toolkit RST-Template <https://jsdoc-toolkit-rst-template.readthedocs.org/en/latest/index.html>`_\n* `sphinx-contrib <https://bitbucket.org/birkenfeld/sphinx-contrib>`_ - Lots of\n  cool stuff here; support for CoffeeScript, Doxygen, Erlang, Excel, Google\n  charts and maps, RESTful HTTP APIs, Ruby, etc.\n* `sphinxcontrib.httpdomain <http://packages.python.org/sphinxcontrib-httpdomain/>`_ - Documenting RESTful HTTP APIs",
        "description_content_type": null,
        "docs_url": null,
        "download_url": null,
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/safarijv/sbo-sphinx",
        "keywords": null,
        "license": null,
        "maintainer": null,
        "maintainer_email": null,
        "name": "sbo-sphinx",
        "package_url": "https://pypi.org/project/sbo-sphinx/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/sbo-sphinx/",
        "project_urls": {
            "Homepage": "http://github.com/safarijv/sbo-sphinx"
        },
        "release_url": "https://pypi.org/project/sbo-sphinx/2.2.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Sphinx configuration and libraries for Safari Books Online documentation",
        "version": "2.2.0"
    },
    "last_serial": 1734061,
    "releases": {
        "2.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "03df0bc8873478c5acd2311764b93c99",
                    "sha256": "faa3cbb6037f2fc28d259ff06d56ccdf683bc080e23ba3d56527d51b17df3605"
                },
                "downloads": -1,
                "filename": "sbo-sphinx-2.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "03df0bc8873478c5acd2311764b93c99",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 883878,
                "upload_time": "2014-03-26T17:06:56",
                "url": "https://files.pythonhosted.org/packages/7d/79/41e5339e882281f1a80e99693159ed4f1766db9b004cc6294f23f7ee063d/sbo-sphinx-2.0.2.tar.gz"
            }
        ],
        "2.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "84669a3b62e9bc67c9bcaff00850b51b",
                    "sha256": "456ccffada3063f5f32306faac379c5dc9853221fce1d794fdd7641dffdeb996"
                },
                "downloads": -1,
                "filename": "sbo-sphinx-2.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "84669a3b62e9bc67c9bcaff00850b51b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 883807,
                "upload_time": "2015-01-30T19:10:24",
                "url": "https://files.pythonhosted.org/packages/57/6a/1064ae98951050c1c5b1398cf0db10b26acda927c32af2c0e62825b9935f/sbo-sphinx-2.0.3.tar.gz"
            }
        ],
        "2.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "19293a34dda65d622e1f55d054d1bf01",
                    "sha256": "785c60cfa135147d31936e5e18fa1341a71c0b1d7bebb58ac75e17ba6ba38e03"
                },
                "downloads": -1,
                "filename": "sbo_sphinx-2.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "19293a34dda65d622e1f55d054d1bf01",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 922362,
                "upload_time": "2015-04-30T18:50:45",
                "url": "https://files.pythonhosted.org/packages/7a/b6/dc737cb2f3b6ad50c142080b4403ae2c754f45bc62a81bab0f36fc80efaf/sbo_sphinx-2.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "68de23e3941608ea5fb3453222555f03",
                    "sha256": "7290daa64817aa6753880e88cef160c7ea618c008c8bf40673638f9e566f9063"
                },
                "downloads": -1,
                "filename": "sbo-sphinx-2.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "68de23e3941608ea5fb3453222555f03",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 883876,
                "upload_time": "2015-04-30T18:50:41",
                "url": "https://files.pythonhosted.org/packages/bb/43/6eb1005fe5006ea220e522da0ed99b27c62ebf652d70e699e33452d62c4b/sbo-sphinx-2.1.0.tar.gz"
            }
        ],
        "2.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8ad4f96af51bce36070488eefcf3dd85",
                    "sha256": "d765eda52339eb8d981bf47cee78555fedf5deaf06017fa94f8d3b8119ef76b0"
                },
                "downloads": -1,
                "filename": "sbo_sphinx-2.1.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8ad4f96af51bce36070488eefcf3dd85",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 924423,
                "upload_time": "2015-06-26T19:03:36",
                "url": "https://files.pythonhosted.org/packages/be/e6/3f4e2fa1afef4da304026e697551e0a6fc8f1c51a06ebef6c422e471f3bb/sbo_sphinx-2.1.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b7b3a8d1858ebd4bacf402e6bb9a7995",
                    "sha256": "7d95737caa0b4664c64d82ddad5ad64e8edc07befc1cbb3001b1a2c309fc7f11"
                },
                "downloads": -1,
                "filename": "sbo-sphinx-2.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b7b3a8d1858ebd4bacf402e6bb9a7995",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 883438,
                "upload_time": "2015-06-26T19:03:40",
                "url": "https://files.pythonhosted.org/packages/0e/be/c3c39485175c5407bef2d3a5173ed6c2af8ce7c6421a07fb41d66dd495bd/sbo-sphinx-2.1.1.tar.gz"
            }
        ],
        "2.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e5c803bce16754ec651b3bee6f3ff833",
                    "sha256": "87539b4909000f2b285f8660243d0ca02918936a04ecedf191abe7fbb0fb7ccf"
                },
                "downloads": -1,
                "filename": "sbo_sphinx-2.2.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e5c803bce16754ec651b3bee6f3ff833",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 1005189,
                "upload_time": "2015-09-22T22:01:23",
                "url": "https://files.pythonhosted.org/packages/ef/8c/f440db98d04af72e6f91deff3c5199fb3da5c52ca4656cd07c243d2d4ad7/sbo_sphinx-2.2.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "40b5f34856756ede523e386486fd1217",
                    "sha256": "4fd5072da6096eb746773eac9ee4db862f87b245d1e52cc352b07445af5f6216"
                },
                "downloads": -1,
                "filename": "sbo-sphinx-2.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "40b5f34856756ede523e386486fd1217",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 965143,
                "upload_time": "2015-09-22T22:01:11",
                "url": "https://files.pythonhosted.org/packages/ca/3c/8568bfcef9abaac70dc2be4b4e46190950550ac56f56249c49572024652f/sbo-sphinx-2.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e5c803bce16754ec651b3bee6f3ff833",
                "sha256": "87539b4909000f2b285f8660243d0ca02918936a04ecedf191abe7fbb0fb7ccf"
            },
            "downloads": -1,
            "filename": "sbo_sphinx-2.2.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e5c803bce16754ec651b3bee6f3ff833",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 1005189,
            "upload_time": "2015-09-22T22:01:23",
            "url": "https://files.pythonhosted.org/packages/ef/8c/f440db98d04af72e6f91deff3c5199fb3da5c52ca4656cd07c243d2d4ad7/sbo_sphinx-2.2.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "40b5f34856756ede523e386486fd1217",
                "sha256": "4fd5072da6096eb746773eac9ee4db862f87b245d1e52cc352b07445af5f6216"
            },
            "downloads": -1,
            "filename": "sbo-sphinx-2.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "40b5f34856756ede523e386486fd1217",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 965143,
            "upload_time": "2015-09-22T22:01:11",
            "url": "https://files.pythonhosted.org/packages/ca/3c/8568bfcef9abaac70dc2be4b4e46190950550ac56f56249c49572024652f/sbo-sphinx-2.2.0.tar.gz"
        }
    ]
}