{ "info": { "author": "Alejandro Alvarez", "author_email": "eliluminado00@gmail.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "**********************\nEditorial Sphinx Theme\n**********************\n\n.. image:: https://gitlab.com/opb/editorial-sphinx-theme/badges/master/build.svg\n :target: https://gitlab.com/opb/editorial-sphinx-theme/commits/master\n :alt: Build Status\n\n.. image:: https://img.shields.io/pypi/dm/editorial_sphinx_theme.svg\n :target: https://pypi.python.org/editorial_sphinx_theme\n :alt: Download per month\n\n.. image:: https://img.shields.io/pypi/v/editorial_sphinx_theme.svg\n :target: https://pypi.python.org/editorial_sphinx_theme\n :alt: Package version\n\n.. image:: https://img.shields.io/pypi/l/editorial_sphinx_theme.svg\n :target: https://pypi.python.org/editorial_sphinx_theme\n :alt: Python License\n\n.. image:: https://img.shields.io/pypi/pyversions/editorial_sphinx_theme.svg\n :target: https://pypi.python.org/editorial_sphinx_theme\n :alt: Supported Python versions\n\n.. image:: https://www.versioneye.com/user/projects/5823a8c39b260e0012ae752b/badge.svg?style=flat-square\n :target: https://www.versioneye.com/user/projects/5823a8c39b260e0012ae752b\n :alt: Dependency npm Status\n\n.. image:: https://www.versioneye.com/user/projects/5823a89936fd2f00164ea6b4/badge.svg?style=flat-square\n :target: https://www.versioneye.com/user/projects/5823a89936fd2f00164ea6b4\n :alt: Dependency PyPi Status\n\nEditorial is a theme for Sphinx, focused to facilitate the reading of the documentation to allow to use the entire\nwidth of the screen, your design is responsive and adapts to any device\n\nLive example of this theme can be seen on:\n\n.. Set up a sample site and captures\n\nThis template is based on Editorial by HTML5 UP (html5up.net), just made the changes needed to use it at the Sphinx.\n\nFeatures\n========\n\n* Easy installation, does not make any extra settings\n* Clean and simple design\n* Responsive, adaptable from mobile devices to PC\n* Hide sidebar with one click\n* Integrated and optional support for Google Analytics\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 editorial_sphinx_theme\n\nIn your ``conf.py`` file:\n\n.. code:: python\n\n import editorial_sphinx_theme\n\n html_theme = \"editorial_sphinx_theme\"\n\n html_theme_path = [editorial_sphinx_theme.get_html_theme_path()]\n\n\nVia git or download\n-------------------\n\nYou can install it directly from the Git repository, keep in mind that this will download the last changes made that\nmay not be stable and lead to failures. For sites in production try to use the version available in PyPi.\n\nThere are two main branches 'master' with stable code and 'develop' with the latest modifications made.\n\nSymlink or subtree the editorial_sphinx_theme/editorial_sphinx_theme repository into your documentation at \ndocs/_themes/editorial_sphinx_theme then add the following two settings to your Sphinx conf.py file:\n\nBranch **master**\n\n.. code:: bash\n\n pip install -e git+https://gitlab.com/opb/editorial-sphinx-theme.git@master#egg=editorial_sphinx_theme\n\nBranch **develop**\n\n.. code:: bash\n\n pip install -e git+https://gitlab.com/opb/editorial-sphinx-theme.git@develop#egg=editorial_sphinx_theme\n\n.. code:: python\n\n html_theme = \"editorial_sphinx_theme\"\n html_theme_path = [\"_themes\", ]\n\n\nOptions\n=======\n\nBasic\n-----\n\nBasic tools or functions\n\n**scroll_to_top**\n\n Include a button in the lower right corner to return to the top of the page.\n\n**prev_next_buttons_bottom**\n\n Navigation buttons at the end of the page, to go to the previous and next page.\n\n**prev_next_buttons_sidebar**\n\n Navigation buttons at the end of the sidebar, to go to the previous and next page.\n\n\nRepo info\n---------\n\nInformation related to the used repository\n\n**repo_name**\n\n Name of the repository service, for example GitLab. This name will be displayed in some parts of the page.\n\n**repo_url**\n\n Repository address, for example: https://gitlab.com/opb/editorial-sphinx-theme\n\n\nGoogle Analytics [Optional]\n---------------------------\n\n**analytics_id**\n\n This indicates the Google Analytics ID used by this service, if you do not pass any value the javascript script\n will not load on the page. The value must have the format \"UA-XXXXX-Y\".\n\n\n**analytics_async**\n\n This option indicates which version of the Google Analytics script to use, for more information in your website\n https://developers.google.com/analytics/devguides/collection/analyticsjs/#alternative_async_tracking_snippet\n\n\nSocial links [Optional]\n-----------------------\n\nAdd in the header a series of links to different social networks, they don't need individual explanation. It is enough\nto indicate the url of the social network to activate it\n\nAvailable: github, bitbucket, gitlab, other_git, twitter, facebook\n\n\nFork Me Ribbon [Optional]\n-------------------------\n\nYou can enable the use of a ribbon in a corner of the page, with the legend \"Fork me on \" and the\ndestination url is the repository specified in the 'repo_url'\n\nThe options that you can use are as follows:\n\n**forkme_ribbon**\n\n It enables the use, only loaded if it is equal to 'True'.\n\n\n**forkme_alignment**\n\n Where shown, take the following locations: left-top, right-top, left-bottom, right-bottom\n\n\n**forkme_fixed**\n\n If you pass 'True' to this option, the ribbon will be shown with the CSS property fixed, and as we scroll on the\n page will continue showing in the same corner.\n\n\nHow To Contribute\n=================\n\n* Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.\n* Fork the repository on GitHub to start making your changes, preferably create a branch to dump these changes.\n* Run or write tests to make sure everything works correctly.\n* Send a pull request when you have finished\n\nLicense\n=======\n\nThis template is distributed under the GNU General Public License v3 (GPLv3) license, for more information see the file LICENSE.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/opb/editorial-sphinx-theme", "keywords": "sphinx theme template editorial", "license": "GNU General Public License v3 (GPLv3)", "maintainer": "", "maintainer_email": "", "name": "editorial-sphinx-theme", "package_url": "https://pypi.org/project/editorial-sphinx-theme/", "platform": "any", "project_url": "https://pypi.org/project/editorial-sphinx-theme/", "project_urls": { "Homepage": "https://gitlab.com/opb/editorial-sphinx-theme" }, "release_url": "https://pypi.org/project/editorial-sphinx-theme/1.0.1/", "requires_dist": null, "requires_python": "", "summary": "A modern and responsive design Sphinx theme", "version": "1.0.1" }, "last_serial": 2456117, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "d099ec7d03938cf243d46daeebfccb30", "sha256": "9659beb20fb4e74467427b0a579fee59bf5219c896775a4e5ce692105df3d1d3" }, "downloads": -1, "filename": "editorial_sphinx_theme-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d099ec7d03938cf243d46daeebfccb30", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 19091, "upload_time": "2016-11-12T05:08:28", "url": "https://files.pythonhosted.org/packages/f2/53/3311279c39e90e3130a63940b3011b21f2b3874fe0a2d6c76b65dd3d6833/editorial_sphinx_theme-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "282a9294e7339a8341286fbf30f95fb2", "sha256": "9276a74503d000d384afe8fb6e51f335346a559a53811f16673bc584d13bc667" }, "downloads": -1, "filename": "editorial_sphinx_theme-1.0.1.tar.gz", "has_sig": false, "md5_digest": "282a9294e7339a8341286fbf30f95fb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 707708, "upload_time": "2016-11-12T05:08:44", "url": "https://files.pythonhosted.org/packages/ee/c3/b080d8f9c1893abf70de62803667ef8caf77840a8160f0994db84cf3af6f/editorial_sphinx_theme-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d099ec7d03938cf243d46daeebfccb30", "sha256": "9659beb20fb4e74467427b0a579fee59bf5219c896775a4e5ce692105df3d1d3" }, "downloads": -1, "filename": "editorial_sphinx_theme-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d099ec7d03938cf243d46daeebfccb30", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 19091, "upload_time": "2016-11-12T05:08:28", "url": "https://files.pythonhosted.org/packages/f2/53/3311279c39e90e3130a63940b3011b21f2b3874fe0a2d6c76b65dd3d6833/editorial_sphinx_theme-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "282a9294e7339a8341286fbf30f95fb2", "sha256": "9276a74503d000d384afe8fb6e51f335346a559a53811f16673bc584d13bc667" }, "downloads": -1, "filename": "editorial_sphinx_theme-1.0.1.tar.gz", "has_sig": false, "md5_digest": "282a9294e7339a8341286fbf30f95fb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 707708, "upload_time": "2016-11-12T05:08:44", "url": "https://files.pythonhosted.org/packages/ee/c3/b080d8f9c1893abf70de62803667ef8caf77840a8160f0994db84cf3af6f/editorial_sphinx_theme-1.0.1.tar.gz" } ] }