{ "info": { "author": "shimizukawa", "author_email": "shimizukawa@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Topic :: Documentation", "Topic :: Utilities" ], "description": "`sphinxcontrib_dashbuilder` generate a 'Documentation Set' intended to be used with the `dash API browser` from a Sphinx documentation.\r\n\r\nYou can read the 'Documentation Set' style document by using `dash API browser`.\r\n\r\n* For Mac OS X users: dash_\r\n* For Windows or Linux users: Zeal_\r\n\r\nThis extension has been inspired by doc2dash_\r\n\r\n.. _dash: http://kapeli.com/dash\r\n.. _Zeal: http://zealdocs.org/\r\n.. _doc2dash: https://pypi.python.org/pypi/doc2dash\r\n\r\nFeatures\r\n==========\r\n\r\nImplemented:\r\n\r\n* Generate a 'Documentation Set' for dash API browser.\r\n\r\n\r\nNot Implemented yet:\r\n\r\n* Keyword indexing with Sphinx i18n translated documentation.\r\n* Disable sidebar\r\n* Table of contents support http://kapeli.com/docsets#tableofcontents\r\n\r\n\r\nInstall\r\n========\r\n\r\n::\r\n\r\n $ pip install sphinxcontrib-dashbuilder\r\n\r\n\r\nIf you wanto to use unrelease version, you can install from repository::\r\n\r\n $ pip install -e hg+https://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder\r\n\r\n\r\nConfiguration\r\n================\r\n\r\nconf.py configuration values:\r\n\r\n:dash_name:\r\n (optional) name for docset explicitly. default is same as `project`.\r\n:dash_icon_file:\r\n (optional) PNG file path for docset icon.\r\n:dash_translator_class:\r\n (optional) A string with the fully-qualified name of a\r\n Dash Translator class, that is, a subclass of Sphinx' DashTranslator,\r\n that is used to translate document trees to HTML for Dash.\r\n Default is None (use the builtin translator).\r\n\r\n\r\nconf.py example::\r\n\r\n extensions = ['sphinxcontrib.dashbuilder']\r\n\r\n dash_name = 'Python_3'\r\n dash_icon_file = '_static/python.png'\r\n\r\n\r\nRun\r\n======\r\n\r\nrun::\r\n\r\n $ sphinx-build -b dash [source] [outdir]\r\n\r\nand you get dash documentation set under '_build/dash/' directory.", "description_content_type": null, "docs_url": "https://pythonhosted.org/sphinxcontrib-dashbuilder/", "download_url": "http://pypi.python.org/pypi/sphinxcontrib-dashbuilder", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-dashbuilder", "package_url": "https://pypi.org/project/sphinxcontrib-dashbuilder/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-dashbuilder/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-dashbuilder", "Homepage": "http://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder" }, "release_url": "https://pypi.org/project/sphinxcontrib-dashbuilder/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "Sphinx builder extension to generate a 'Documentation Set' for `dash API browser`.", "version": "0.1.0" }, "last_serial": 1103061, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "60a2851cf5d438ca1f7f5d93aaa0f2e8", "sha256": "227a6e62bd37d90181a617024c68297ed87a6b5c7abe9d5313a90c9e2e836d9d" }, "downloads": -1, "filename": "sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "60a2851cf5d438ca1f7f5d93aaa0f2e8", "packagetype": "bdist_wheel", "python_version": "3.3", "requires_python": null, "size": 8179, "upload_time": "2014-05-24T08:05:48", "url": "https://files.pythonhosted.org/packages/22/62/543f4c1b9d5db9c4222e86c6cb2eb6c8c0bac3803f987082cf5bb46e95ad/sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "82d90986540b6409b69b629423630b44", "sha256": "3d9d624df3a3b536a290ce0231cdd0dfee6aa48553ac4a3e6a5c278b6fc9636a" }, "downloads": -1, "filename": "sphinxcontrib-dashbuilder-0.1.0.zip", "has_sig": false, "md5_digest": "82d90986540b6409b69b629423630b44", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16512, "upload_time": "2014-05-24T08:05:45", "url": "https://files.pythonhosted.org/packages/0c/ee/49200a707ab595932a2273d6d55091fbf66f3c665db4485bf77f6889305c/sphinxcontrib-dashbuilder-0.1.0.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "60a2851cf5d438ca1f7f5d93aaa0f2e8", "sha256": "227a6e62bd37d90181a617024c68297ed87a6b5c7abe9d5313a90c9e2e836d9d" }, "downloads": -1, "filename": "sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "60a2851cf5d438ca1f7f5d93aaa0f2e8", "packagetype": "bdist_wheel", "python_version": "3.3", "requires_python": null, "size": 8179, "upload_time": "2014-05-24T08:05:48", "url": "https://files.pythonhosted.org/packages/22/62/543f4c1b9d5db9c4222e86c6cb2eb6c8c0bac3803f987082cf5bb46e95ad/sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "82d90986540b6409b69b629423630b44", "sha256": "3d9d624df3a3b536a290ce0231cdd0dfee6aa48553ac4a3e6a5c278b6fc9636a" }, "downloads": -1, "filename": "sphinxcontrib-dashbuilder-0.1.0.zip", "has_sig": false, "md5_digest": "82d90986540b6409b69b629423630b44", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16512, "upload_time": "2014-05-24T08:05:45", "url": "https://files.pythonhosted.org/packages/0c/ee/49200a707ab595932a2273d6d55091fbf66f3c665db4485bf77f6889305c/sphinxcontrib-dashbuilder-0.1.0.zip" } ] }