{ "info": { "author": "Bernardo Mart\u00ednez Garrido", "author_email": "programming@bernardomg.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Sphinx", "Framework :: Sphinx :: Theme", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Documentation", "Topic :: Documentation :: Sphinx", "Topic :: Software Development :: Documentation" ], "description": "=================\nSphinx Docs Theme\n=================\n\nA minimalist Bootstrap-based HTML5 theme for Sphinx. For generating\ndocumentation sites.\n\nCheck the `latest docs`_ to find out how to set it up.\n\nThe skin has been adapted from the static template `Docs Bootstrap Template`_,\nand it is the visual reference to be followed by the project.\n\n.. image:: https://badge.fury.io/py/sphinx-docs-theme.svg\n :target: https://pypi.python.org/pypi/sphinx-docs-theme\n :alt: Sphinx docs theme Pypi package page\n\n.. image:: https://img.shields.io/badge/docs-release-blue.svg\n :target: http://docs.bernardomg.com/sphinx-docs-theme\n :alt: Sphinx docs theme latest documentation\n.. image:: https://img.shields.io/badge/docs-develop-blue.svg\n :target: http://docs.bernardomg.com/development/sphinx-docs-theme\n :alt: Sphinx docs theme development documentation\n\nFeatures\n--------\n\n- Minimalist and reactive look\n- `HTML5`_\n- `Bootstrap 3`_\n- `Font Awesome`_ icons\n- `highlight.js`_ for syntax highlighting\n- Prepared for `Facebook's Open Graph`_ and `Twitter Cards`_\n\nDemo\n----\n\nTo check the Sphinx Docs Theme at work take a look at the documentation, linked\nbelow this section, which is created with Sphinx and making use of this theme.\n\nDocumentation\n-------------\n\nDocumentation sources are included with the project, and used to generate the\ndocumentation sites:\n\n- The `latest docs`_ are always generated for the latest release, kept in the 'master' branch\n- The `development docs`_ are generated from the latest code in the 'develop' branch\n\nThe source files for the docs, a small `Sphinx`_ project, are kept in the 'docs folder.\n\nThese can be built if needed:\n\n``$ python setup.py build_docs``\n\nUsage\n-----\n\nThe project is a `Sphinx`_ theme, which can be used in a similar way to any\nother such theme.\n\nPrerequisites\n~~~~~~~~~~~~~\n\n`Sphinx`_ is required to make use of this theme, as it is meant to be integrated\ninto a Sphinx project. To find more information about this check its webpage,\nwhich will also tell which Python interpreters can be used.\n\nAll other Python dependencies are indicated on the requirements.txt file.\n\nThese dependencies can be installed with:\n\n``$ pip install --upgrade -r requirements.txt``\n\nThe frontend libraries are defined as `npm`_ dependencies, and require this package\nmanager to be defined.\n\nThese dependencies can be installed with:\n\n``$ python setup.py frontend``\n\nInstalling\n~~~~~~~~~~\n\nThe project is offered as a `Pypi package`_, and using pip is the preferred way\nto install it. For this use the following command;\n\n``$ pip install sphinx-docs-theme``\n\nIf needed, manual installation is possible:\n\n``$ python setup.py install``\n\nUsing it as a dependency\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf the project has been installed in the local libraries repository, it can be\nused just by adding the following lines to the conf.py file of any Sphinx\nproject:\n\n.. code::\n\n import sphinx_docs_theme\n\n html_theme = 'sphinx_docs_theme'\n html_theme_path = sphinx_docs_theme.get_html_theme_path()\n\nUsing it from the Sphinx themes folder\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAnother possibility is just adding the project code, contained int the\n'sphinx_docs_theme' folder, to the themes folder of your Sphinx project, which\nis:\n\n``docs\\_themes\\sphinx_docs_theme\\``\n\nAnd then it is just needed to add the following files to the conf.py file:\n\n.. code::\n\n html_theme = 'sphinx_docs_theme'\n html_theme_path = [\"_themes\", ]\n\nCollaborate\n-----------\n\nAny kind of help with the project will be well received, and there are two main\nways to give such help:\n\n- Reporting errors and asking for extensions through the issues management\n- or forking the repository and extending the project\n\nIssues management\n~~~~~~~~~~~~~~~~~\n\nIssues are managed at the GitHub `project issues tracker`_, where any Github\nuser may report bugs or ask for new features.\n\nGetting the code\n~~~~~~~~~~~~~~~~\n\nIf you wish to fork or modify the code, visit the `GitHub project page`_, where\nthe latest versions are always kept. Check the 'master' branch for the latest\nrelease, and the 'develop' for the current, and stable, development version.\n\nLicense\n-------\n\nThe project has been released under the `MIT License`_.\n\n\n.. _Docs Bootstrap Template: https://github.com/Bernardo-MG/docs-bootstrap-template\n.. _Sphinx: http://sphinx-doc.org/\n.. _GitHub project page: https://github.com/Bernardo-MG/sphinx-docs-theme\n.. _project issues tracker: https://github.com/Bernardo-MG/sphinx-docs-theme/issues\n.. _latest docs: http://docs.bernardomg.com/sphinx-docs-theme\n.. _development docs: http://docs.bernardomg.com/development/sphinx-docs-theme\n.. _Pypi package: https://pypi.python.org/pypi/sphinx-docs-theme\n.. _MIT License: http://www.opensource.org/licenses/mit-license.php\n\n.. _npm: https://www.npmjs.com/\n\n.. _HTML5: http://www.w3.org/TR/html5/\n.. _Bootstrap 3: http://getbootstrap.com\n.. _Font Awesome: https://fortawesome.github.io/Font-Awesome/\n.. _highlight.js: https://highlightjs.org/\n.. _Facebook's Open Graph: http://ogp.me/\n.. _Twitter Cards: https://dev.twitter.com/cards/overview\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/Bernardo-MG/sphinx-docs-theme", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Bernardo-MG/sphinx-docs-theme", "keywords": "sphinx,theme,bootstrap,html5,python", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-docs-theme", "package_url": "https://pypi.org/project/sphinx-docs-theme/", "platform": "any", "project_url": "https://pypi.org/project/sphinx-docs-theme/", "project_urls": { "Download": "https://github.com/Bernardo-MG/sphinx-docs-theme", "Homepage": "https://github.com/Bernardo-MG/sphinx-docs-theme" }, "release_url": "https://pypi.org/project/sphinx-docs-theme/0.3.5/", "requires_dist": [ "Fabric", "Sphinx", "tox ; extra == 'test'" ], "requires_python": "", "summary": "Sphinx Theme for documentation sites.", "version": "0.3.5" }, "last_serial": 5168521, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "83b630368d9c6e372c405f3227fc2030", "sha256": "398b65e3c4675c514fccbd55daf8c2e52c521b9270bf4de712e9666d1e978e50" }, "downloads": -1, "filename": "sphinx-docs-theme-0.1.0.zip", "has_sig": false, "md5_digest": "83b630368d9c6e372c405f3227fc2030", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 797609, "upload_time": "2015-09-24T19:23:42", "url": "https://files.pythonhosted.org/packages/a1/cc/fdb07d274a1fda2d57b6e2a9f84786a557881b14832c482ebad3b75355fb/sphinx-docs-theme-0.1.0.zip" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "ed5d2af3252198f1041d89b4eaef16a5", "sha256": "b7d941115eaa496ea518f42d7fbb263f768314059a8956339aaac005c48f37ca" }, "downloads": -1, "filename": "sphinx_docs_theme-0.1.1-py2.7.egg", "has_sig": false, "md5_digest": "ed5d2af3252198f1041d89b4eaef16a5", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 696016, "upload_time": "2015-11-10T21:27:13", "url": "https://files.pythonhosted.org/packages/f2/c8/f55b5a4079ae607305538004d779cd83fd8af7611c1c3184cc59fd426c1e/sphinx_docs_theme-0.1.1-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "b13b425bab7c215aab6a688bb7f6b064", "sha256": "77658bdd46ec1bf68a368834e64f297bef6fa3d06d362593baccbc81e10e675f" }, "downloads": -1, "filename": "sphinx-docs-theme-0.1.1.zip", "has_sig": false, "md5_digest": "b13b425bab7c215aab6a688bb7f6b064", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1627729, "upload_time": "2015-11-10T21:27:05", "url": "https://files.pythonhosted.org/packages/1c/12/db8473b4e1df99f328e2b9eab324faeaed92c840b9f4a6ed38802c27afa6/sphinx-docs-theme-0.1.1.zip" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "75c0a1520f296f409f6b6b35e5192222", "sha256": "6a49806f0a35edb1362a525dec35dac6cfea3fcfaaf8ad197d2223e77b84b503" }, "downloads": -1, "filename": "sphinx-docs-theme-0.1.2.zip", "has_sig": false, "md5_digest": "75c0a1520f296f409f6b6b35e5192222", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 788188, "upload_time": "2015-11-10T22:05:41", "url": "https://files.pythonhosted.org/packages/a2/a5/7626ffd124ac747291f07eed31c4a90b5dd3241f32aaca32347075622093/sphinx-docs-theme-0.1.2.zip" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "16842bd4d55b9d483a4ce54d8650a475", "sha256": "86dad7dfed5fdbe03aa03ee02873aa6c449f5600adaf154811b6fa2aead7dd5a" }, "downloads": -1, "filename": "sphinx-docs-theme-0.2.0.zip", "has_sig": false, "md5_digest": "16842bd4d55b9d483a4ce54d8650a475", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 874077, "upload_time": "2016-09-08T14:39:08", "url": "https://files.pythonhosted.org/packages/d5/1f/aef9369b144ddc8a8f1542ad3791c71e4232389429fb43edb363d1113f86/sphinx-docs-theme-0.2.0.zip" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "1e45bcd8efabc3e5cb5cfa94c0ee44a3", "sha256": "52ed5bf8bcb4f518e2f2beaea6e4bbe6f20c19ceffa0a3e9715bdbb2d358ba6e" }, "downloads": -1, "filename": "sphinx_docs_theme-0.2.1-py2.7.egg", "has_sig": false, "md5_digest": "1e45bcd8efabc3e5cb5cfa94c0ee44a3", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 1400985, "upload_time": "2016-10-12T15:35:20", "url": "https://files.pythonhosted.org/packages/05/b4/375d4c7a36499129579be4c350a471267b1f805fb2ced22ba9c8ff5b36b3/sphinx_docs_theme-0.2.1-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "737d12e222e61ff875e922b0f5def646", "sha256": "e61fc519cb77cfb6443cc4ab56062deb8414c984718c8113b2ec714743da5fc7" }, "downloads": -1, "filename": "sphinx-docs-theme-0.2.1.tar.gz", "has_sig": false, "md5_digest": "737d12e222e61ff875e922b0f5def646", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 799838, "upload_time": "2016-10-12T15:35:12", "url": "https://files.pythonhosted.org/packages/09/5c/9f46f7f1d20f2cef0da42efc2e86f026a95fe6bfa13ae9c7662cc181f7a7/sphinx-docs-theme-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "2949213de8fa18099d23e35e24ba56f8", "sha256": "26f17bf2844e86188fc1224109535ce3fdb103adf1d40d25901195a02d0b4149" }, "downloads": -1, "filename": "sphinx-docs-theme-0.2.2.tar.gz", "has_sig": false, "md5_digest": "2949213de8fa18099d23e35e24ba56f8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 799846, "upload_time": "2016-10-12T21:00:14", "url": "https://files.pythonhosted.org/packages/30/b2/f33c46b2bd3da66984cead80fff5de3e8617c2dd2011d42f534845236d15/sphinx-docs-theme-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "cb269b5c98cdaf6aa363ab6973051e10", "sha256": "d00d0bd2cb0db1c22926a4025c7dae58f8bc81ec3c6fdc9532a3b1cecf82e783" }, "downloads": -1, "filename": "sphinx-docs-theme-0.2.3.tar.gz", "has_sig": false, "md5_digest": "cb269b5c98cdaf6aa363ab6973051e10", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 799848, "upload_time": "2016-10-21T15:07:03", "url": "https://files.pythonhosted.org/packages/9c/4d/df97876384bd7d6752fd97a55f9d12f67931daf849f907735886878bf067/sphinx-docs-theme-0.2.3.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "6a43755d5ce9288d9854c271904a9edf", "sha256": "2f5dadd6735a3095ae01ad54b91e8628d697833e8b60fe101f2366452ced250e" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.0.tar.gz", "has_sig": false, "md5_digest": "6a43755d5ce9288d9854c271904a9edf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2422239, "upload_time": "2018-01-13T22:36:59", "url": "https://files.pythonhosted.org/packages/66/7f/7a3180a9fee56b060e4591593574d052bf9ece2d1caed750e3d4f9e17f16/sphinx-docs-theme-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "0dba89695c139e2f6ff279e643d7e858", "sha256": "5b9d83418c99f88ef19a833874d5f53ec032d99d819b189e7f599c893c0da387" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.1.tar.gz", "has_sig": false, "md5_digest": "0dba89695c139e2f6ff279e643d7e858", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1973711, "upload_time": "2018-03-15T21:16:43", "url": "https://files.pythonhosted.org/packages/46/67/8b7745051283bf749cc630bfec84ce35864ab0f2cf274308cda554a5dc77/sphinx-docs-theme-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "fc0443ed4f45079c9b03bf97779efd76", "sha256": "34fcc24b2ae99db2c7e5e0e137f9d31ad98ae97f619b414fd30a0eb8e109f684" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.2.tar.gz", "has_sig": false, "md5_digest": "fc0443ed4f45079c9b03bf97779efd76", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1039465, "upload_time": "2018-03-15T21:36:06", "url": "https://files.pythonhosted.org/packages/d1/ef/609a21b7aa8bc0d163fe43eba97c8ac7c1984eb7f1263aa8d5e2cf9d59c1/sphinx-docs-theme-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "340b302cacc2d3c925b7571337c4b4e6", "sha256": "430f445558085faad5292d6dfa954a8e983b4b4085ec17d695adfd5152472cd0" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.3.tar.gz", "has_sig": false, "md5_digest": "340b302cacc2d3c925b7571337c4b4e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1042832, "upload_time": "2019-04-20T19:54:25", "url": "https://files.pythonhosted.org/packages/4a/4d/e720b0ad5e1276bf08bec09d42bc3e56014cf37fe4656a506b55445a5aff/sphinx-docs-theme-0.3.3.tar.gz" } ], "0.3.4": [ { "comment_text": "", "digests": { "md5": "bc05ca11a60063f6400566a86fb6c64d", "sha256": "52b296e241c5bb05e6cd67aa3e27d0c8735b3e1adfb56e3302bbceec1e13e1bc" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.4.tar.gz", "has_sig": false, "md5_digest": "bc05ca11a60063f6400566a86fb6c64d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1042924, "upload_time": "2019-04-20T19:55:44", "url": "https://files.pythonhosted.org/packages/42/64/0c2b84e648b04f3a40afed10f4c0f718060c05a840cb701cc81917d94767/sphinx-docs-theme-0.3.4.tar.gz" } ], "0.3.5": [ { "comment_text": "", "digests": { "md5": "3f1938635bfe5670bc6c0a70bdd74fa7", "sha256": "800298da0932ab3a497206182363a08a015c03ff3f7a9cc7ff5e6247f5f8173f" }, "downloads": -1, "filename": "sphinx_docs_theme-0.3.5-py3-none-any.whl", "has_sig": false, "md5_digest": "3f1938635bfe5670bc6c0a70bdd74fa7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 974830, "upload_time": "2019-04-20T20:36:59", "url": "https://files.pythonhosted.org/packages/e5/68/e4a4789154064fba0e67c7c2376003c91f999a49a539a23b41ae0d39b924/sphinx_docs_theme-0.3.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "82755449210791ca971563b7d723dbd5", "sha256": "0d0d2ecbe3e375a8b01272b7e226761448c0649415bb01bd4231a10076bddbd7" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.5.tar.gz", "has_sig": false, "md5_digest": "82755449210791ca971563b7d723dbd5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 962171, "upload_time": "2019-04-20T20:37:01", "url": "https://files.pythonhosted.org/packages/97/97/e52a36788834ce2c41f0632ccffca1483426165f3a38e3ec36cf177b8340/sphinx-docs-theme-0.3.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3f1938635bfe5670bc6c0a70bdd74fa7", "sha256": "800298da0932ab3a497206182363a08a015c03ff3f7a9cc7ff5e6247f5f8173f" }, "downloads": -1, "filename": "sphinx_docs_theme-0.3.5-py3-none-any.whl", "has_sig": false, "md5_digest": "3f1938635bfe5670bc6c0a70bdd74fa7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 974830, "upload_time": "2019-04-20T20:36:59", "url": "https://files.pythonhosted.org/packages/e5/68/e4a4789154064fba0e67c7c2376003c91f999a49a539a23b41ae0d39b924/sphinx_docs_theme-0.3.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "82755449210791ca971563b7d723dbd5", "sha256": "0d0d2ecbe3e375a8b01272b7e226761448c0649415bb01bd4231a10076bddbd7" }, "downloads": -1, "filename": "sphinx-docs-theme-0.3.5.tar.gz", "has_sig": false, "md5_digest": "82755449210791ca971563b7d723dbd5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 962171, "upload_time": "2019-04-20T20:37:01", "url": "https://files.pythonhosted.org/packages/97/97/e52a36788834ce2c41f0632ccffca1483426165f3a38e3ec36cf177b8340/sphinx-docs-theme-0.3.5.tar.gz" } ] }