{ "info": { "author": "edX", "author_email": "oscm@edx.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Sphinx :: Theme", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5" ], "description": "edx-sphinx-theme\n================\n\n.. image:: https://img.shields.io/pypi/v/edx-sphinx-theme.svg\n :target: https://pypi.python.org/pypi/edx-sphinx-theme/\n :alt: PyPI\n\n.. image:: https://travis-ci.org/edx/edx-sphinx-theme.svg?branch=master\n :target: https://travis-ci.org/edx/edx-sphinx-theme\n :alt: Travis\n\n.. image:: http://codecov.io/github/edx/edx-sphinx-theme/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/edx-sphinx-theme?branch=master\n :alt: Codecov\n\n.. image:: https://readthedocs.org/projects/edx-sphinx-theme/badge/?version=latest\n :target: http://edx-sphinx-theme.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. image:: https://img.shields.io/pypi/pyversions/edx-sphinx-theme.svg\n :target: https://pypi.python.org/pypi/edx-sphinx-theme/\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/github/license/edx/edx-sphinx-theme.svg\n :target: https://github.com/edx/edx-sphinx-theme/blob/master/LICENSE.txt\n :alt: License\n\nedx-sphinx-theme is a Sphinx theme for `Open edX`_ documentation. It should be\nused for all documentation in repositories in the ``edx`` GitHub organization\nwhich is intended to be used with the `Sphinx`_ documentation system.\n\n.. _Open edX: https://open.edx.org/\n.. _Sphinx: http://www.sphinx-doc.org/en/stable/\n\nOverview\n--------\n\nThis theme makes the following changes to the default Sphinx output:\n\n* Displays the edX logo\n* Adds a link to a feedback form that identifies which page the feedback came from\n\nTo use edx-sphinx-theme for a repository's documentation:\n\n* ``pip install edx-sphinx-theme`` or equivalent (add ``edx-sphinx-theme``\n to any appropriate requirements files)\n* Add ``edx_theme`` to the ``extensions`` list in conf.py (it adds the\n feedback form URL to the rendering context for each page).\n* Update the ``html_theme`` and ``html_theme_path`` values in conf.py so the\n theme can be located and loaded.\n* Set ``html_favicon`` to the path of the favicon.ico file in the theme.\n* Use the ``AUTHOR`` constant where appropriate in conf.py\n (this default is only provided as a convenience; the repository is free\n to use another value if appropriate).\n\nFor example:\n\n.. code-block:: python\n\n import os\n import edx_theme\n\n extensions = ['edx_theme']\n\n copyright = '{year}, edX Inc.'.format(year=datetime.datetime.now().year)\n author = edx_theme.AUTHOR\n\n html_theme = 'edx_theme'\n html_theme_path = [edx_theme.get_html_theme_path()]\n html_favicon = os.path.join(html_theme_path[0], 'edx_theme', 'static', 'css', 'favicon.ico')\n\n latex_documents = [\n (master_doc, 'edx-sphinx-theme.tex', 'edx-sphinx-theme Documentation',\n author, 'manual'),\n ]\n\nRead the Docs Configuration\n---------------------------\n\nBecause this theme is a Python package which needs to be installed, `Read the\nDocs`_ needs to be configured appropriately to be able to install it when\nperforming documentation builds. Under ``Advanced Settings``:\n\n* ``Install your project inside a virtualenv using setup.py install`` should\n be checked\n* ``Requirements file`` should point to a pip requirements file which includes\n ``open-edx-theme``.\n\n.. _Read the Docs: https://readthedocs.org/\n\nDocumentation\n-------------\n\nThe full documentation is at https://edx-sphinx-theme.readthedocs.org.\n\nLicense\n-------\n\nThe code in this repository is licensed under the Apache Software License 2.0 unless\notherwise noted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\n\nPlease read `How To Contribute `_ for details.\n\nEven though they were written with ``edx-platform`` in mind, the guidelines\nshould be followed for Open edX code in general.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about Open edX in general? Please\nrefer to this `list of resources`_ if you need any assistance.\n\n.. _list of resources: https://open.edx.org/getting-help\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to edx-sphinx-theme will be documented\n in this file. It adheres to the structure of http://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (http://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n[1.4.0] - 2018-12-04\n~~~~~~~~~~~~~~~~~~~~\n\n* Added support for the ``includehidden`` theme option. This shows a hidden toc\n in sidebar.\n\n* Upgraded many dependencies.\n\n[1.3.0] - 2017-10-13\n~~~~~~~~~~~~~~~~~~~~\n\n* Added support for the ``navigation_depth`` theme option.\n\n[1.2.0] - 2017-07-18\n~~~~~~~~~~~~~~~~~~~~\n\n* The text of the help and feedback links are now variables settable in the\n html_context.\n\n* Updated the copyright year.\n\n[1.1.0] - 2017-06-28\n~~~~~~~~~~~~~~~~~~~~\n\n* Supply extension metadata to enable parallel builds.\n\n[1.0.2] - 2016-11-09\n~~~~~~~~~~~~~~~~~~~~\n\n* Added favicon and .eot font file to distributed package.\n\n[1.0.1] - 2016-10-14\n~~~~~~~~~~~~~~~~~~~~\n\n* Fixed two instances of line-height being slightly increased in an ugly way.\n\n[1.0] - 2016-10-07\n~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* First release on PyPI.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/edx/edx-sphinx-theme", "keywords": "Sphinx edx", "license": "Apache Software License 2.0", "maintainer": "", "maintainer_email": "", "name": "edx-sphinx-theme", "package_url": "https://pypi.org/project/edx-sphinx-theme/", "platform": "", "project_url": "https://pypi.org/project/edx-sphinx-theme/", "project_urls": { "Homepage": "https://github.com/edx/edx-sphinx-theme" }, "release_url": "https://pypi.org/project/edx-sphinx-theme/1.5.0/", "requires_dist": [ "six", "Sphinx" ], "requires_python": "", "summary": "A Sphinx theme for Open edX documentation", "version": "1.5.0" }, "last_serial": 5418789, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "b95b47fb8934673f9a2ccaa0e125fdae", "sha256": "a068a3a91d73a6d1071785152db0e1771ae59467c6513bc46441b84b132a53eb" }, "downloads": -1, "filename": "edx_sphinx_theme-1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b95b47fb8934673f9a2ccaa0e125fdae", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 176740, "upload_time": "2016-10-07T19:15:44", "url": "https://files.pythonhosted.org/packages/cf/72/5e4863feb66559723c1bf9104560384be33f55d572bea5e0a19eb2bc73f3/edx_sphinx_theme-1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "92ae857d64fc5a631ad8ca263866a509", "sha256": "de214c1025380ba94a47121876d973454b4653b1e439479c630cc77016a12c8b" }, "downloads": -1, "filename": "edx-sphinx-theme-1.0.tar.gz", "has_sig": false, "md5_digest": "92ae857d64fc5a631ad8ca263866a509", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 179511, "upload_time": "2016-10-07T19:15:47", "url": "https://files.pythonhosted.org/packages/d4/f9/80f1143ecb5cc5b5d43cdff17654af43bf9b449caa7140981979fe701741/edx-sphinx-theme-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "40338d6627dcb41c5ac3e70ec84adc88", "sha256": "82525d1ec1cfcd3985e1fe25fb4dbce24c88488d7e9fa86eca452240762ee594" }, "downloads": -1, "filename": "edx_sphinx_theme-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "40338d6627dcb41c5ac3e70ec84adc88", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 176930, "upload_time": "2016-10-17T16:23:30", "url": "https://files.pythonhosted.org/packages/c4/09/b2d73e476d00a49c82e498b178f6548edd465dc51528d569706a63ed8591/edx_sphinx_theme-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c7c24829c346ae553fa91ab98ae7d2f5", "sha256": "74a605df3c68ab842c88072e47299cc7e2922cf8e9713fb0040921af6dd88d9b" }, "downloads": -1, "filename": "edx-sphinx-theme-1.0.1.tar.gz", "has_sig": false, "md5_digest": "c7c24829c346ae553fa91ab98ae7d2f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 179663, "upload_time": "2016-10-17T16:23:33", "url": "https://files.pythonhosted.org/packages/dc/d5/c477f373c7fb63faf70e5dce37f7b642e4d9f59e28c1e1235358be16d9be/edx-sphinx-theme-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "a664d997024ff804d2596c356fd9845d", "sha256": "a5acd53d3f9198af72e013c430894a17b59a3d6e26869906241ffa4b40ffa8d9" }, "downloads": -1, "filename": "edx_sphinx_theme-1.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a664d997024ff804d2596c356fd9845d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 216943, "upload_time": "2016-11-09T14:59:10", "url": "https://files.pythonhosted.org/packages/40/db/c0422dc916caa1a8b05f3370b0e3fd4df23228cdf94ad13a4186b37f0fb0/edx_sphinx_theme-1.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "421abdea8c66e984baf66ab280f01a86", "sha256": "0dd2a227f714f3a65f1144b6279a9c6ab00a3d1f64b855ccf0cbe88f6801ea18" }, "downloads": -1, "filename": "edx-sphinx-theme-1.0.2.tar.gz", "has_sig": false, "md5_digest": "421abdea8c66e984baf66ab280f01a86", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 219782, "upload_time": "2016-11-09T14:59:13", "url": "https://files.pythonhosted.org/packages/84/cb/2ee3d82174de7fbe684f0d9f1baa0f2ae4a2f4cf98acaf5402480344a697/edx-sphinx-theme-1.0.2.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "8c3c56cf03977f9296f6efc8b2a891f2", "sha256": "983cda504c4c1ed1493792dc978fb3867674a098d761871db0a32b5a0063ebb1" }, "downloads": -1, "filename": "edx_sphinx_theme-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8c3c56cf03977f9296f6efc8b2a891f2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 217295, "upload_time": "2017-06-28T15:42:45", "url": "https://files.pythonhosted.org/packages/cc/58/a9d891dc7873a4cb5e4c236d13b7aab30600f8f3de7513d865e7b7b20957/edx_sphinx_theme-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "03e8d01a8da5fd8b59b2d41059edfaeb", "sha256": "f66de7e04b955ad1215e038f9885d49ef9077a35b65dbbee8bcb815e6a488138" }, "downloads": -1, "filename": "edx-sphinx-theme-1.1.0.tar.gz", "has_sig": false, "md5_digest": "03e8d01a8da5fd8b59b2d41059edfaeb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 220118, "upload_time": "2017-06-28T15:42:47", "url": "https://files.pythonhosted.org/packages/e7/c1/cde921c38606ec6cd5b92ef43d8847af799038d72544a3560c6dd6243df7/edx-sphinx-theme-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "c093834b82dab2d3727a4bb326e875ed", "sha256": "5ae4f145377d3c0659fc9cd2a14fb35fcdfc53d6b56a655d455c4e9acfed2948" }, "downloads": -1, "filename": "edx_sphinx_theme-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c093834b82dab2d3727a4bb326e875ed", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 217444, "upload_time": "2017-07-20T20:29:08", "url": "https://files.pythonhosted.org/packages/e4/38/5103ec4835768b328e0dddb6e98f128e73c7716bf820adf3033958fc0a42/edx_sphinx_theme-1.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f7f259874d911210753bdd5b3152da9c", "sha256": "ada03e1e1d39d33fd0b671c3f55ee406e9ab535ec94513978d9f9d657682e7f5" }, "downloads": -1, "filename": "edx-sphinx-theme-1.2.0.tar.gz", "has_sig": false, "md5_digest": "f7f259874d911210753bdd5b3152da9c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 220280, "upload_time": "2017-07-20T20:29:10", "url": "https://files.pythonhosted.org/packages/d3/9d/157ad5de9b83222c4a210b10ac39bec7bf93caf3eccb5a18427b66a08eb9/edx-sphinx-theme-1.2.0.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "5b205b4314994092a98a6a3e30db9ee7", "sha256": "7316d99af250fef38b5a6050da9bd361b488d0c7961cfd7d957b12b1390c2436" }, "downloads": -1, "filename": "edx_sphinx_theme-1.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5b205b4314994092a98a6a3e30db9ee7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 217535, "upload_time": "2017-10-13T21:29:40", "url": "https://files.pythonhosted.org/packages/e8/43/1784275d8af6b5e6dd34388b235aabf08bce55ab0d33783a6636bd1eda3f/edx_sphinx_theme-1.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3ae6408437cc734fc6ef1c7e63010909", "sha256": "664e7b614a4388d47cb6ccf2c69966f8e2bb09091f7b92f3d1704ca0c24399d8" }, "downloads": -1, "filename": "edx-sphinx-theme-1.3.0.tar.gz", "has_sig": false, "md5_digest": "3ae6408437cc734fc6ef1c7e63010909", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 220366, "upload_time": "2017-10-13T21:29:43", "url": "https://files.pythonhosted.org/packages/e0/0c/bc81b81f0bf91e32d51a690a74282a8e4397cac115df04298695c1241f5c/edx-sphinx-theme-1.3.0.tar.gz" } ], "1.4.0": [ { "comment_text": "", "digests": { "md5": "d4b26344fea50320acd5f80da8ec6240", "sha256": "fb66ec991391b42ab618eafe29cf5dcee7c3f7ead0e2eb0387b9a91331e7eb3e" }, "downloads": -1, "filename": "edx_sphinx_theme-1.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d4b26344fea50320acd5f80da8ec6240", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 219056, "upload_time": "2018-12-05T20:29:07", "url": "https://files.pythonhosted.org/packages/04/cb/0c5fca4565318b95d8c92110b1c196d47eae3525c4972ea53c8c465639f6/edx_sphinx_theme-1.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b4a5e284d7b5e2a455e9350f36700541", "sha256": "d5f78fcc25ab3a6ec1214b1b135dde10310d9f962fded7817da3254ebc3aa06a" }, "downloads": -1, "filename": "edx-sphinx-theme-1.4.0.tar.gz", "has_sig": false, "md5_digest": "b4a5e284d7b5e2a455e9350f36700541", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 223137, "upload_time": "2018-12-05T20:29:09", "url": "https://files.pythonhosted.org/packages/76/de/05680d954921f5dc30f302b08bba6b2f22c7a3c8fab46633bf2a4699c180/edx-sphinx-theme-1.4.0.tar.gz" } ], "1.5.0": [ { "comment_text": "", "digests": { "md5": "1a9d9a00c926dd3df120eb5119aca6b2", "sha256": "dd0ad09bfabd9c9f0ffffc185778c385504ca6f0aa27972131a88352ef44d926" }, "downloads": -1, "filename": "edx_sphinx_theme-1.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1a9d9a00c926dd3df120eb5119aca6b2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 219060, "upload_time": "2019-06-19T06:04:51", "url": "https://files.pythonhosted.org/packages/6c/72/faaadd7051909a6dafaf69674d2a9b1a9955389b9e94e2159b33e2c82331/edx_sphinx_theme-1.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f5e9c1c2b8763e32fe2a4591f7e8be44", "sha256": "f56af9996b2521343bed0a104b9c959bd95aec107b07b7cb3777bbdb061c0c97" }, "downloads": -1, "filename": "edx-sphinx-theme-1.5.0.tar.gz", "has_sig": false, "md5_digest": "f5e9c1c2b8763e32fe2a4591f7e8be44", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 219545, "upload_time": "2019-06-19T06:04:53", "url": "https://files.pythonhosted.org/packages/34/e9/6cfff8a8260ea44ab1e9644259450b3a7fc1cff49d74447b36c0290c2059/edx-sphinx-theme-1.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1a9d9a00c926dd3df120eb5119aca6b2", "sha256": "dd0ad09bfabd9c9f0ffffc185778c385504ca6f0aa27972131a88352ef44d926" }, "downloads": -1, "filename": "edx_sphinx_theme-1.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1a9d9a00c926dd3df120eb5119aca6b2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 219060, "upload_time": "2019-06-19T06:04:51", "url": "https://files.pythonhosted.org/packages/6c/72/faaadd7051909a6dafaf69674d2a9b1a9955389b9e94e2159b33e2c82331/edx_sphinx_theme-1.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f5e9c1c2b8763e32fe2a4591f7e8be44", "sha256": "f56af9996b2521343bed0a104b9c959bd95aec107b07b7cb3777bbdb061c0c97" }, "downloads": -1, "filename": "edx-sphinx-theme-1.5.0.tar.gz", "has_sig": false, "md5_digest": "f5e9c1c2b8763e32fe2a4591f7e8be44", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 219545, "upload_time": "2019-06-19T06:04:53", "url": "https://files.pythonhosted.org/packages/34/e9/6cfff8a8260ea44ab1e9644259450b3a7fc1cff49d74447b36c0290c2059/edx-sphinx-theme-1.5.0.tar.gz" } ] }