{
    "info": {
        "author": "Paul Carduner, Zope Foundation and Contributors",
        "author_email": "zope-dev@zope.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Framework :: Buildout",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: Zope Public License",
            "Natural Language :: English",
            "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",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy"
        ],
        "description": "======================\n z3c.recipe.sphinxdoc\n======================\n\nIntroduction\n============\n\nThis buildout recipe aids in the generation of documentation for the\nzope.org website from restructured text files located in a package.\nIt uses Sphinx to build static html files which can stand alone as a\nvery nice looking website.\n\nUsage Instructions\n==================\n\nSuppose you have a package called ``z3c.form``.  In the ``setup.py``\nfor ``z3c.form`` it is recommended that you add a ``docs`` section\nto the extras_require argument.  It should look something like this::\n\n    extras_require = dict(\n        docs = ['Sphinx',\n                'z3c.recipe.sphinxdoc']\n        )\n\nThen in the buildout.cfg file for your package, add a ``docs`` section\nthat looks like this::\n\n  [docs]\n  recipe = z3c.recipe.sphinxdoc\n  eggs = z3c.form [docs]\n\nBe sure to include it in the parts, as in::\n\n  [buildout]\n  develop = .\n  parts = docs\n\nNow you can rerun buildout.  The recipe will have created an\nexecutable script in the bin directory called ``docs``.\n\nThis script will run the Sphinx documentation generation tool on your\nsource code.  By default, it expects there to be an ``index.rst`` file\nin the source code.  In this case, ``index.rst`` would have to be in\n``src/z3c/form/index.rst``.  This file can be a standard restructured\ntext file, and can use all the sphinx goodies.  For example, your\n``index.txt`` might look like this::\n\n  Welcome to z3c.form's documentation!\n  ====================================\n\n  Contents:\n\n  .. toctree::\n     :maxdepth: 2\n\n     README\n\n  Indices and tables\n  ==================\n\n  * :ref:`genindex`\n  * :ref:`modindex`\n  * :ref:`search`\n\nYou should read the documentation for Sphinx to learn more about it.\nIt is available here: http://sphinx.pocoo.org/\n\nNow you should be able to run the ``docs`` script::\n\n  $ ./bin/docs\n\nThis generates all the documentation for you and placed it in the\nparts directory.  You can then open it up in firefox and take a look::\n\n  $ firefox parts/docs/z3c.form/build/index.html\n\nAdditional Options\n==================\n\nBy default, this recipe generates documentation that looks like the\nnew zope website ( http://new.zope.org ) by overriding the default\nlayout template and css file used by sphinx.  You can modify this\nbehavior with options in your buildout configuration.\n\nGive me back Sphinx's default look!\n-----------------------------------\n\nTo get back the default look of sphinx, you could use a configuration\nlike this::\n\n  [docs]\n  recipe = z3c.recipe.sphinxdoc\n  eggs = z3c.form [docs]\n  default.css =\n  layout.html =\n\nI want my own custom look\n-------------------------\n\nYou can also specify your own layout template and css like so::\n\n  [docs]\n  recipe = z3c.recipe.sphinxdoc\n  eggs = z3c.form [docs]\n  default.css = http://my.own.website.com/mystyles/some-theme.css\n  layout.html = /path/to/layout.html\n\nNote that you can either specify a path on the local file system or a\nurl to an external css file.\n\nUse sphinx extension modules\n----------------------------\n\nSphinx provides a set of extensions, for example ``sphinx.ext.autodoc``\nor ``sphinx.ext.doctest``. To use such an extension change your\nconfiguration like::\n\n  [docs]\n  recipe = z3c.recipe.sphinxdoc\n  eggs = z3c.form [docs]\n  extensions = sphinx.ext.autodoc sphinx.ext.doctest\n\nArbitrary Configuration\n-----------------------\n\nSphinx and its extensions offer many configuration options. You can\nspecify any of those by using the ``extra-conf`` option. This option\ntakes a sequence of lines that are simply inserted into the generated\n``conf.py``. Anything you specify here will override other settings\nthis recipe established (just watch your leading line indentation)::\n\n  [docs]\n  recipe = z3c.recipe.sphinxdoc\n  eggs = z3c.form [docs]\n  extensions = sphinx.ext.autodoc\n               sphinx.ext.todo\n               sphinx.ext.viewcode\n               sphinx.ext.intersphinx\n               repoze.sphinx.autointerface\n               sphinxcontrib.programoutput\n  default.css =\n  layout.html =\n  extra-conf =\n           autodoc_default_flags = ['members', 'show-inheritance',]\n           autoclass_content = 'both'\n           intersphinx_mapping = {\n           'python':  ('http://docs.python.org/2.7/', None),\n           'boto': ('http://boto.readthedocs.org/en/latest/', None),\n           'gunicorn': ('http://docs.gunicorn.org/en/latest/', None),\n           'pyquery': ('http://packages.python.org/pyquery/', None) }\n           intersphinx_cache_limit = -1\n           todo_include_todos = True\n\n           # The suffix of source filenames. Override back to txt.\n           source_suffix = '.txt'\n\n           # Choose an entire theme. Note that we disabled layout.html\n           # and default.css.\n           html_theme = 'classic'\n\n\n=========\n CHANGES\n=========\n\n1.1.0 (2017-07-05)\n==================\n\n- Add support for Python 3.4, 3.5 and 3.6 and PyPy.\n\n- Remove support for Python 2.6 and 3.3.\n\n- Change the default source suffix from ``.txt`` to ``.rst``. You can\n  override this using the new ``extra-conf`` setting.\n\n- Add the ability to specify arbitrary configuration in the\n  ``extra-conf`` setting. This is useful for things like configuring\n  extensions, overriding the defaults set by this recipe, and\n  configuring a sphinx theme.\n\n- Stop forcing a value of ``default.css`` for ``html_style`` even when\n  the ``default.css`` setting is configured to an empty value. This\n  makes it possible to use ``html_theme`` to set a sphinx theme, and\n  it properly lets the default Sphinx theme be used (by setting both\n  ``default.css`` and ``layout.html`` to empty values).\n\n- Ignore bad eggs in the documentation working set. Previously they\n  would raise internal errors without any explanation. Now, they log a\n  warning pinpointing the bad egg. Fixes `issue 6\n  <https://github.com/zopefoundation/z3c.recipe.sphinxdoc/issues/6>`_.\n\n\n1.0.0 (2013-02-23)\n==================\n\n- Added Python 3.3 support.\n\n- Bug: fix layout directory if layout is overriden by user\n\n0.0.8 (2009-05-01)\n==================\n\n- Feature: Added new option `doc-eggs` which specifies the list of eggs for\n  which to create documentation explicitely.\n\n- Feature: Changed building behavior so that the documentation for each\n  package is built in its own sub-directory.\n\n- Feature: Added new option `extensions` which takes a whitespace\n  separated list of sphinx extension modules. This extensions can be\n  used to build the documentation.\n\n0.0.7 (2009-02-15)\n==================\n\n- Bug: fix python 2.4 support\n\n- Bug: fix broken srcDir path generation for windows\n\n0.0.6 (2009-01-19)\n==================\n\n- Feature: Allow you to specify a url or local file path to your own\n  default.css and layout.html files.\n\n0.0.5 (2008-05-11)\n==================\n\n- Initial release.\n\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/zopefoundation/z3c.recipe.sphinxdoc/",
        "keywords": "buildout sphinx docs recipe",
        "license": "ZPL 2.1",
        "maintainer": "",
        "maintainer_email": "",
        "name": "z3c.recipe.sphinxdoc",
        "package_url": "https://pypi.org/project/z3c.recipe.sphinxdoc/",
        "platform": "",
        "project_url": "https://pypi.org/project/z3c.recipe.sphinxdoc/",
        "project_urls": {
            "Homepage": "https://github.com/zopefoundation/z3c.recipe.sphinxdoc/"
        },
        "release_url": "https://pypi.org/project/z3c.recipe.sphinxdoc/1.1.0/",
        "requires_dist": [
            "Sphinx",
            "docutils",
            "setuptools",
            "zc.buildout",
            "zc.recipe.egg",
            "zope.testing; extra == 'test'",
            "zope.testrunner; extra == 'test'"
        ],
        "requires_python": "",
        "summary": "Use Sphinx to build documentation for zope.org.",
        "version": "1.1.0"
    },
    "last_serial": 3002101,
    "releases": {
        "0.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a0ae456440cab972c280df9446403624",
                    "sha256": "bf9f93b7afc5c7825f17d6d5282c9f8f7289991742822ce21c3ae7c61a46db64"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-0.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "a0ae456440cab972c280df9446403624",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11456,
                "upload_time": "2008-05-11T17:41:39",
                "url": "https://files.pythonhosted.org/packages/d9/5d/5e0a04795fcfdc3bf383c05f64a9b58c3cb7c80bc2faf29cc2195866f812/z3c.recipe.sphinxdoc-0.0.5.tar.gz"
            }
        ],
        "0.0.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6f13ada56a3dcf038db2acd776b93a8c",
                    "sha256": "c7bbcc89fba38df32fc39a990277f74f5ba2ecfcfc786d24cedec0ca9e45429d"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-0.0.6.tar.gz",
                "has_sig": false,
                "md5_digest": "6f13ada56a3dcf038db2acd776b93a8c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12032,
                "upload_time": "2009-01-19T19:51:11",
                "url": "https://files.pythonhosted.org/packages/a7/7d/3c6036f9aaa21198ced9810d877353266f1fd8e5c04168965b83f28b86f1/z3c.recipe.sphinxdoc-0.0.6.tar.gz"
            }
        ],
        "0.0.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a65f476ed776176547e2e602b5c49d2c",
                    "sha256": "d94de166fcbec34a3b28f60e01b4aaeb6e04b0ec823a6c9d7719e1720057c50d"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-0.0.7.zip",
                "has_sig": false,
                "md5_digest": "a65f476ed776176547e2e602b5c49d2c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20257,
                "upload_time": "2009-02-15T01:00:15",
                "url": "https://files.pythonhosted.org/packages/e2/93/5e253e6efd109aad2b677e5381a34a809033645e5fe4053580d72a22bb71/z3c.recipe.sphinxdoc-0.0.7.zip"
            }
        ],
        "0.0.8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "86e6965c919b43fa1de07588580f8790",
                    "sha256": "abd66c69fc91877a4b7616985b15b0e8dd6e213efda8c2ae71bfa59e1129422a"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-0.0.8.tar.gz",
                "has_sig": false,
                "md5_digest": "86e6965c919b43fa1de07588580f8790",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12642,
                "upload_time": "2009-05-01T18:56:47",
                "url": "https://files.pythonhosted.org/packages/7e/2e/17609fa5d52eed8abbf756c3d5b68f4e50c01416c8cdb807a3461ab3b4c3/z3c.recipe.sphinxdoc-0.0.8.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6a1b87e101cd9ac8221f77c4683ee585",
                    "sha256": "6615ecc2b4b93e9f2db4444d05621adbf6a14f0f2e092794deb30cb322821023"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "6a1b87e101cd9ac8221f77c4683ee585",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 15172,
                "upload_time": "2013-02-24T21:14:05",
                "url": "https://files.pythonhosted.org/packages/d5/4e/2fdd9666feffb5731007ce34e83ad8a19481b30da6812a008dfbef3d901d/z3c.recipe.sphinxdoc-1.0.0.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "933cdf34a471ab14f5eb3c146f660bd8",
                    "sha256": "fa3a9af3238c3fa36d876c2019cdb00efd3bb5260189b14a0df48330f27494e7"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-1.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "933cdf34a471ab14f5eb3c146f660bd8",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 22449,
                "upload_time": "2017-07-05T21:54:04",
                "url": "https://files.pythonhosted.org/packages/38/24/6c7ba2b81f98af0b33021c1d2cf119d87ee92bd7285b015d3833d0ec9a3d/z3c.recipe.sphinxdoc-1.1.0-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "3721a2baa2e43385e4847151e209df18",
                    "sha256": "27efe2a4c78b4272aada596e4ada2182c6edb61d5152a1a25d483dcd2c19c0ba"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-1.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3721a2baa2e43385e4847151e209df18",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 22446,
                "upload_time": "2017-07-05T21:52:31",
                "url": "https://files.pythonhosted.org/packages/f3/eb/952739a97740fc97dae88ce4a2d1d31ab4d4526e130cdea08081493cc2c4/z3c.recipe.sphinxdoc-1.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8728d40166492e3091ac627a7c73aede",
                    "sha256": "9e2ac4d17544a1a4939d225440655471e2fe675256fd34453a4dae96cb2f0d6a"
                },
                "downloads": -1,
                "filename": "z3c.recipe.sphinxdoc-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "8728d40166492e3091ac627a7c73aede",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 21906,
                "upload_time": "2017-07-05T21:52:34",
                "url": "https://files.pythonhosted.org/packages/f2/b1/e8f020e067840c04395c8c79a13093107300a20190d7028c5a7f32df5db8/z3c.recipe.sphinxdoc-1.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "933cdf34a471ab14f5eb3c146f660bd8",
                "sha256": "fa3a9af3238c3fa36d876c2019cdb00efd3bb5260189b14a0df48330f27494e7"
            },
            "downloads": -1,
            "filename": "z3c.recipe.sphinxdoc-1.1.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "933cdf34a471ab14f5eb3c146f660bd8",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 22449,
            "upload_time": "2017-07-05T21:54:04",
            "url": "https://files.pythonhosted.org/packages/38/24/6c7ba2b81f98af0b33021c1d2cf119d87ee92bd7285b015d3833d0ec9a3d/z3c.recipe.sphinxdoc-1.1.0-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "3721a2baa2e43385e4847151e209df18",
                "sha256": "27efe2a4c78b4272aada596e4ada2182c6edb61d5152a1a25d483dcd2c19c0ba"
            },
            "downloads": -1,
            "filename": "z3c.recipe.sphinxdoc-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3721a2baa2e43385e4847151e209df18",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 22446,
            "upload_time": "2017-07-05T21:52:31",
            "url": "https://files.pythonhosted.org/packages/f3/eb/952739a97740fc97dae88ce4a2d1d31ab4d4526e130cdea08081493cc2c4/z3c.recipe.sphinxdoc-1.1.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "8728d40166492e3091ac627a7c73aede",
                "sha256": "9e2ac4d17544a1a4939d225440655471e2fe675256fd34453a4dae96cb2f0d6a"
            },
            "downloads": -1,
            "filename": "z3c.recipe.sphinxdoc-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8728d40166492e3091ac627a7c73aede",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 21906,
            "upload_time": "2017-07-05T21:52:34",
            "url": "https://files.pythonhosted.org/packages/f2/b1/e8f020e067840c04395c8c79a13093107300a20190d7028c5a7f32df5db8/z3c.recipe.sphinxdoc-1.1.0.tar.gz"
        }
    ]
}