{ "info": { "author": "Birdhouse", "author_email": "wps-dev@dkrz.de", "bugtrack_url": null, "classifiers": [ "Framework :: Buildout", "Intended Audience :: Developers", "Programming Language :: Python :: 2", "Topic :: Scientific/Engineering :: Atmospheric Science", "Topic :: Software Development :: Build Tools", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "******************************\nbirdhousebuilder.recipe.sphinx\n******************************\n\n.. image:: https://travis-ci.org/bird-house/birdhousebuilder.recipe.sphinx.svg?branch=master\n :target: https://travis-ci.org/bird-house/birdhousebuilder.recipe.sphinx\n :alt: Travis Build\n\nIntroduction\n************\n\nBuildout Recipe to setup Sphinx Documentation for `Birdhouse`_ Components.\n\nThe recipe is based on https://pypi.python.org/pypi/collective.recipe.sphinxbuilder\n\n.. _`Buildout`: http://buildout.org/\n.. _`Anaconda`: http://continuum.io/\n.. _`Birdhouse`: http://bird-house.github.io\n\nUsage\n*****\n\nThe recipe requires that `Anaconda`_ is already installed. You can use the buildout option ``anaconda-home`` to set the prefix for the anaconda installation. Otherwise the environment variable ``CONDA_PREFIX`` (variable is set when activating a conda environment) is used as conda prefix. \n\nThe recipe builds an initial docs folder for Sphinx in `docs`. \nThe recipe configures `sphinx-autoapi` to generate the api reference documetation from the source code. \n\nThe recipe depends on ``birdhousebuilder.recipe.conda`` and ``zc.recipe.egg``\n\nSupported Options\n=================\n\nThe recipe supports the following options:\n\n**project** (default: `MyBird`)\n Specify the project name.\n\n**author** (default: `Birdhouse`)\n Specify the author of the project.\n\n**version** (default: `0.1`)\n Specify the version of the project.\n\n**use_autoapi** (default: `true`)\n Set to `fals` if you don't want to use the `sphinx-autoapi`. \n \n**src** (default: `.`) \n Specify path to source folder which will be used by `sphinx-autoapi`.\n\nExample Usage\n=============\n\nSet up the docs for the project `Emu`:\n\n.. code-block:: ini\n\n [buildout]\n parts = sphinx\n\n [sphinx]\n recipe = birdhousebuilder.recipe.sphinx\n project = Emu\n version = 0.2\n src = emu\n \n\n\n\n\n\n\nCarsten Ehbrecht \n\n\nChanges\n*******\n\n0.2.4 (2018-01-17)\n==================\n\n* pep8.\n* using alabaster theme.\n* using pywps autodoc extension.\n\n0.2.3 (2016-07-25)\n==================\n\n* added birdhouse to intersphinx.\n\n0.2.2 (2016-07-15)\n==================\n\n* fixed twitcher link.\n\n0.2.1 (2016-07-11)\n==================\n\n* updated to latest conda recipe.\n* updated test suite.\n\n0.2.0 (2016-07-01)\n==================\n\n* replaced conda.makedirs by os.makedirs.\n\n0.1.7 (2016-06-02)\n==================\n\n* fixed readthedocs urls.\n\n0.1.6 (2016-06-01)\n==================\n\n* rst_epilog links added.\n* ignore localhost links.\n* linkcheck_timeout added.\n\n0.1.5 (2016-02-19)\n==================\n\n* added use_autoapi option.\n\n0.1.4 (2016-02-19)\n==================\n\n* added linkcheck options.\n\n0.1.3 (2015-10-24)\n==================\n\n* setups requirements/rtd.txt for readthedocs.\n\n0.1.2 (2015-10-24)\n==================\n\n* replaced autodoc by sphinx-autoapi extension\n* using src option for sphinx-autoapi\n\n0.1.1 (2015-10-23)\n==================\n\n* added extra_paths\n* added sys.path in conf.py template\n\n0.1.0 (2015-10-23)\n==================\n\nInitial Release", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/birdhouse/birdhousebuilder.recipe.sphinx", "keywords": "buildout sphinx birdhouse", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "birdhousebuilder.recipe.sphinx", "package_url": "https://pypi.org/project/birdhousebuilder.recipe.sphinx/", "platform": "", "project_url": "https://pypi.org/project/birdhousebuilder.recipe.sphinx/", "project_urls": { "Homepage": "https://github.com/birdhouse/birdhousebuilder.recipe.sphinx" }, "release_url": "https://pypi.org/project/birdhousebuilder.recipe.sphinx/0.2.4/", "requires_dist": null, "requires_python": "", "summary": "Buildout recipe to generate and Sphinx-based documentation for Birdhouse.", "version": "0.2.4" }, "last_serial": 3497918, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "bd315802ffc5ac9c59c9f5d49a0f7f7c", "sha256": "feccfd42fbc3eac125928173530c6c71bec31af04dc1386e2647ba64266bf3d6" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.0.tar.gz", "has_sig": false, "md5_digest": "bd315802ffc5ac9c59c9f5d49a0f7f7c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14098, "upload_time": "2015-10-23T12:20:26", "url": "https://files.pythonhosted.org/packages/4b/91/6f100b5af5366eac48901403ccc315aa92b775a9e4af11870904592973cf/birdhousebuilder.recipe.sphinx-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "0044911be054e22d360a8938bf685d2a", "sha256": "666999065458b9b402f55b631f36774c53153ad48484597418bc1b5a870a5be6" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0044911be054e22d360a8938bf685d2a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14273, "upload_time": "2015-10-23T14:02:20", "url": "https://files.pythonhosted.org/packages/a9/0c/c57192627b6e1b4a698927eac479f8b4cb80c0aeda357349fcaa68c6c9a9/birdhousebuilder.recipe.sphinx-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "9e6152303b5c7ff4e877326076c13a88", "sha256": "34309c38cb7f46c589cd2233a9b0b8ca7c2ba3e7047140b14029ca06cd8c51e3" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.2.tar.gz", "has_sig": false, "md5_digest": "9e6152303b5c7ff4e877326076c13a88", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14602, "upload_time": "2015-10-24T16:24:39", "url": "https://files.pythonhosted.org/packages/a2/75/5a8f6f47b02ab11eb8763e3723bce8a7b9ee3ea4790463ae04b0dac50924/birdhousebuilder.recipe.sphinx-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "91c633613bc0e4bd388e1fa976dcc716", "sha256": "52327d88290344aa29e157ef16f87fa0e31918732f4ab67fc5ce89a7e5581253" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.3.tar.gz", "has_sig": false, "md5_digest": "91c633613bc0e4bd388e1fa976dcc716", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14800, "upload_time": "2015-10-24T17:36:46", "url": "https://files.pythonhosted.org/packages/e9/9b/5c063aabaec7965bb69936fad8b3566a512bf3d073cd9a679b5f23988d18/birdhousebuilder.recipe.sphinx-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "50d3af83c2cc1f3fb155bc88afc33f26", "sha256": "36a5c09c2b61ca38a35e50943c9a8cf4e011fb9927e52e90abfffe0e15ff3652" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.4.tar.gz", "has_sig": false, "md5_digest": "50d3af83c2cc1f3fb155bc88afc33f26", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14863, "upload_time": "2016-02-19T14:39:38", "url": "https://files.pythonhosted.org/packages/c8/fa/1fc0e5647ded81d0142a96d6f2bb850be6494fcbcc5c7fbc97ae430291cd/birdhousebuilder.recipe.sphinx-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "29672a87b4d5cbe987dedd0b043680f7", "sha256": "2ecb924fe261df4dad11065ca69c3c9f4b6ece97b6acb1eaa333ac1ab1e78110" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.5.tar.gz", "has_sig": false, "md5_digest": "29672a87b4d5cbe987dedd0b043680f7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14990, "upload_time": "2016-02-19T16:24:54", "url": "https://files.pythonhosted.org/packages/14/e9/6d0c2386b35d7d5115f0c19eb723d1690f641b0e2f312911215b3539066b/birdhousebuilder.recipe.sphinx-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "14848ec4197a330c86b9d458a3058ad2", "sha256": "a1e9d4447e5096bcdc3b5a2d806bb396786d91a33362cc1a5913eef40a6c7c16" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.6.tar.gz", "has_sig": false, "md5_digest": "14848ec4197a330c86b9d458a3058ad2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15299, "upload_time": "2016-06-01T13:51:07", "url": "https://files.pythonhosted.org/packages/cf/42/b286c07bb7a1c3eb6f1b1ad4f238b50cc14f131011c5229a10997024a173/birdhousebuilder.recipe.sphinx-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "c8746ed33ae81f4135e0c98c3bfcbf67", "sha256": "147270aa09600d558d107568d361dd8bf55a36662921eebc1f7cf217315dad51" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.1.7.tar.gz", "has_sig": false, "md5_digest": "c8746ed33ae81f4135e0c98c3bfcbf67", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15398, "upload_time": "2016-06-02T14:50:54", "url": "https://files.pythonhosted.org/packages/b1/d4/223cf3ad12c3e0ce74ca2b75d96b02c5eb246e124f7f92bcde3cab611612/birdhousebuilder.recipe.sphinx-0.1.7.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "a86f31d5d35c6e2548685a048857b8a8", "sha256": "2efb4cade6f89d87d24157c2d29dcc4bf94457f71e6953102bca16e9dd62b3b8" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.2.0.tar.gz", "has_sig": false, "md5_digest": "a86f31d5d35c6e2548685a048857b8a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15583, "upload_time": "2016-07-01T12:19:13", "url": "https://files.pythonhosted.org/packages/04/0e/430207ec8f4e0d0c04bfa39e5dd1da06956227301aca53bd1d2495ca9223/birdhousebuilder.recipe.sphinx-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "4c9bb2d891f203d78b4751c9c6a1e282", "sha256": "24d35ef1fc14449c3165998176fc6642e416c603af485b12d9bdafc9e4081e6b" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.2.1.tar.gz", "has_sig": false, "md5_digest": "4c9bb2d891f203d78b4751c9c6a1e282", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16256, "upload_time": "2016-07-11T09:27:10", "url": "https://files.pythonhosted.org/packages/a1/1c/315a378c5635ba288ba8ef102b28951f69b714fbbc9ac4473fb940e50900/birdhousebuilder.recipe.sphinx-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "8e319380f3a57bb45d3625d7fb8464bd", "sha256": "187959c8d2630982a2dc1388f39d9e33a10db6e29de9f0b23f55121848ff73fb" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.2.2.tar.gz", "has_sig": false, "md5_digest": "8e319380f3a57bb45d3625d7fb8464bd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16285, "upload_time": "2016-07-15T15:52:20", "url": "https://files.pythonhosted.org/packages/b5/32/99eea2b52a076fc3c837e5f8cc908475f6d74471b08728e521dacf18d7d1/birdhousebuilder.recipe.sphinx-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "32989431cd60b3459aef5150663a7f4b", "sha256": "aa33047cf8c383772938570bf887184602b2733dc52a63f0a48407dc874acd0b" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.2.3.tar.gz", "has_sig": false, "md5_digest": "32989431cd60b3459aef5150663a7f4b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16279, "upload_time": "2016-07-25T15:11:05", "url": "https://files.pythonhosted.org/packages/06/64/99966b9256db7c7fff725cc86584f1a41082ba727e3d422d88a1685a05b2/birdhousebuilder.recipe.sphinx-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "697b1147b6a1a9e1c24e510efc08aceb", "sha256": "57017eddb2be2832b310a8dadea2581bfb579465514e949e66498258ddac7b3e" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.2.4.tar.gz", "has_sig": false, "md5_digest": "697b1147b6a1a9e1c24e510efc08aceb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17193, "upload_time": "2018-01-17T17:41:39", "url": "https://files.pythonhosted.org/packages/db/c1/2b4c97a90d421bf78ad2d8789bb7d4d57da2f8142084e219896734a5bc1a/birdhousebuilder.recipe.sphinx-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "697b1147b6a1a9e1c24e510efc08aceb", "sha256": "57017eddb2be2832b310a8dadea2581bfb579465514e949e66498258ddac7b3e" }, "downloads": -1, "filename": "birdhousebuilder.recipe.sphinx-0.2.4.tar.gz", "has_sig": false, "md5_digest": "697b1147b6a1a9e1c24e510efc08aceb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17193, "upload_time": "2018-01-17T17:41:39", "url": "https://files.pythonhosted.org/packages/db/c1/2b4c97a90d421bf78ad2d8789bb7d4d57da2f8142084e219896734a5bc1a/birdhousebuilder.recipe.sphinx-0.2.4.tar.gz" } ] }