{ "info": { "author": "Olivier Amblet", "author_email": "olivier.amblet@epfl.ch", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": ".. _collaboratory: https://collab.humanbrainproject.eu\n.. _bower: http://www.bower.io\n.. _sphinx: http://www.sphinx-doc.org\n.. _sass: http://www.sass-lang.com\n.. _wyrm: http://www.github.com/snide/wyrm/\n.. _grunt: http://www.gruntjs.com\n.. _node: http://www.nodejs.com\n.. _demo: https://collab.humanbrainproject.eu/#/collab/54/nav/368\n.. _repository: https://github.com/HumanBrainProject/hbp-sphinx-theme\n.. _release: https://github.com/HumanBrainProject/hbp-sphinx-theme/releases/latest\n.. _documentation example: https://github.com/HumanBrainProject/hbp-collaboratory-doc-example\n\n.. image:: https://travis-ci.org/HumanBrainProject/hbp-sphinx-theme.svg?branch=master\n :target: https://travis-ci.org/HumanBrainProject/hbp-sphinx-theme\n\n******************************\nHBP Collaboratory Sphinx Theme\n******************************\n\n.. contents::\n\nView a working demo_ over on collaboratory_.\n\nThis package provide a Sphinx theme for documentation integrated into the\nCollaboratory. It can be used for standalone websites as well.\n\n.. image:: screen_integrated.png\n :width: 100%\n\nInstallation\n============\n\nVia package\n-----------\n\nDownload the package or add it to your requirements.txt file:\n\n.. code:: bash\n\n pip install hbp_sphinx_theme\n\n\nIn your conf.py file:\n\n.. code:: Python\n\n import hbp_sphinx_theme\n html_theme = \"hbp_sphinx_theme\"\n html_theme_path = [hbp_sphinx_theme.get_html_theme_path()]\n\n\nVia download\n------------\n\nDownload the ``hbp_sphinx_theme.zip`` provided by the latest release_\nto your documentation project directory.\n\nAs explained in `sphinx documentation`__, in your ``conf.py`` file:\n\n__ http://sphinx-doc.org/theming.html#using-a-theme\n\n\n.. code:: python\n\n html_theme = 'hbp_sphinx_theme'\n html_theme_path = ['.']\n\n\nContributing or modifying the theme\n===================================\n\nHBP Collaboratory Sphinx Theme github project can be included in your documentation\nproject as a git submodule. This will enable you to modify the theme and see the\nchanges immediately in your browser. Please have a look at the `documentation example`_\nproject on how to set up. After you are happy with the changes, you've made to the theme,\nplease make a pull request for us to review.\n\nBuild and release the theme\n===========================\n\nThe build and release is done using grunt.\n\n.. code:: bash\n\n grunt release\n\n`Changelog`__\n\n__ CHANGELOG.md", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/HumanBrainProject/hbp-sphinx-theme/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "hbp-sphinx-theme", "package_url": "https://pypi.org/project/hbp-sphinx-theme/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/hbp-sphinx-theme/", "project_urls": { "Homepage": "https://github.com/HumanBrainProject/hbp-sphinx-theme/" }, "release_url": "https://pypi.org/project/hbp-sphinx-theme/0.3.4/", "requires_dist": null, "requires_python": "", "summary": "Human Brain Project Sphinx Theme.", "version": "0.3.4" }, "last_serial": 1892699, "releases": { "0.3.3": [ { "comment_text": "", "digests": { "md5": "c754e1908afc433358b46fcbe8cb2655", "sha256": "cffd80b1551723bcb6edd9ae27a9c9cd67388be157787b4323602270d92def3b" }, "downloads": -1, "filename": "hbp-sphinx-theme-0.3.3.tar.gz", "has_sig": false, "md5_digest": "c754e1908afc433358b46fcbe8cb2655", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 385914, "upload_time": "2016-01-04T17:27:06", "url": "https://files.pythonhosted.org/packages/8b/cb/e9f366646804d050e03b1b757b166dca0707be4def0651f9f1c2d0b7bacc/hbp-sphinx-theme-0.3.3.tar.gz" } ], "0.3.4": [ { "comment_text": "", "digests": { "md5": "26b373615cd0667c507863df08a32ebd", "sha256": "ebd3e7f665e15dc056222edeeba4bf702d556c0eafc838fe738945420d6bd403" }, "downloads": -1, "filename": "hbp-sphinx-theme-0.3.4.tar.gz", "has_sig": false, "md5_digest": "26b373615cd0667c507863df08a32ebd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 384883, "upload_time": "2016-01-07T11:13:22", "url": "https://files.pythonhosted.org/packages/29/9f/94a120bfa664c3fdea9f085fa4828d37a9d06cc30ee86ea9028341fc6398/hbp-sphinx-theme-0.3.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "26b373615cd0667c507863df08a32ebd", "sha256": "ebd3e7f665e15dc056222edeeba4bf702d556c0eafc838fe738945420d6bd403" }, "downloads": -1, "filename": "hbp-sphinx-theme-0.3.4.tar.gz", "has_sig": false, "md5_digest": "26b373615cd0667c507863df08a32ebd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 384883, "upload_time": "2016-01-07T11:13:22", "url": "https://files.pythonhosted.org/packages/29/9f/94a120bfa664c3fdea9f085fa4828d37a9d06cc30ee86ea9028341fc6398/hbp-sphinx-theme-0.3.4.tar.gz" } ] }