{ "info": { "author": "Peter Hudec", "author_email": "peterhudec@peterhudec.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet", "Topic :: Software Development :: Documentation", "Topic :: Text Processing :: Markup" ], "description": ".. |foundation| replace:: Foundation 4\n.. _foundation: http://foundation.zurb.com/\n\n=======================\nSphinx Foundation Theme\n=======================\n\nThis is a Sphinx theme based on the |foundation|_ css framework.\nIt was created as a by-product of the `Authomatic `_\nauthentication / authorization library.\n\nFeatures\n--------\n\n*\tResponsive design\n*\tSupport for SVG in ```` tags with fallback to PNG\n*\tGoogle Analytics support\n*\tFork Me On Github support\n* **pip** installable\n*\tSEO rudiments\n\t\n\t*\tSEO meta tags\n\t*\tOpen Graph meta tags\n\t*\tFacebbok, Twitter and Google+ social buttons\n\t*\tAuthorship Google Rich Snippet\n\nUsage\n-----\n\nIstall with pip.\n\n.. code-block:: bash\n\n\t$ pip install foundation-sphinx-theme\n\nSet the ``html_theme`` variable to ``'foundation'``.\n\n.. code-block:: python\n\t\n\t# conf.py\n\timport foundation_sphinx_theme\n\n\t# The theme to use for HTML and HTML Help pages. See the documentation for\n\t# a list of builtin themes.\n\thtml_theme = 'foundation_sphinx_theme'\n\n\t# Add any paths that contain custom themes here, relative to this directory.\n\thtml_theme_path = foundation_sphinx_theme.HTML_THEME_PATH\n\nYou also need to add the ``foundation`` extension in the ``conf.py``.\nThe extension just injects some foundation |foundation|_ css classes\nneeded for creation of the top bar navigation.\n\n.. code-block:: python\n\t\n\t# conf.py\n\n\tsys.path[0:0] = [os.path.abspath('_themes/foundation-sphinx-theme')]\n\textensions = ['sphinx.ext.autodoc', 'foundation_sphinx_theme']\n\nStyles\n^^^^^^\n\nThere are two ready made styles.\n\n*\t``foundation/css/basic.css`` `See demo. `_\n*\t``foundation/css/cards.css`` `See demo. `_\n\nIf you want to customize them or make your own,\nextend the ``sass`` sources in ``foundation/static/foundation/sass``.\n\nPage Specific SEO Description\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nUse the ``..seo-description::`` directive if you want to have different SEO description\nthan the one specified in ``html_theme_options`` for a specific document/page.\nThe directive can appear anywhere in the document.\nIf you specify more than one, the content of the last one will be used.\n\n.. code-block:: rst\n\t\n\t.. seo-description::\n\n\t\tContent of this directive overrides the seo_description\n\t\tin the html_theme_options only for this page.\n\n\t======================\n\tTitle of Your Document\n\t======================\n\n\t.. seo-description::\n\t \n\t Value of the last seo-description directive will be used.\n\nOptions\n^^^^^^^\n\nThere are these theme options available:\n\n.. code-block:: python\n\t\n\t# conf.py\n\t\n\thtml_theme_options = {\n\t\t'motto': 'Long description which appears next to logo.',\n\n\t\t# Your stylesheet relative to the _static dir.\n\t\t# Default is 'foundation/css/basic.css'\n\t\t'stylesheet': '/path/to/your/stylesheet.css',\n\n\t\t# Logo image in SVG format. If the browser doesn't support SVG\n\t\t# It will try to load JPG with the same name.\n\t\t'logo_screen': '',\n\n\t\t# Logo for small screens. If ommited, logo_screen will be used.\n\t\t'logo_mobile': '',\n\n\t\t# Path to your favicon.ico file relative to the _static dir.\n\t\t'favicon': '',\n\n\t\t# Use this if the top-level items of the toctree don't fit in the top-bar navigation.\n\t\t# If True, the whole toctree will be placed inside a single top-level item.\n\t\t'top_bar_force_fit': True,\n\n\t\t# The title of the aformentioned top-level item. Default is \"Sections\"\n\t\t'top_bar_content_title': 'Sections',\n\n\t\t# If set, Google Analytics code will be appended to body of each page.\n\t\t'google_analytics_id': 'your-google-analytics-id',\n\n\t\t# The \"og:title\", \"og:type\", \"og:url\", \"og:site_name\" and \"og:description\" Open Graph tags\n\t\t# will be generated automatically, but you should specify the\n\t\t# path to the image that you want to be used\n\t\t# in the required \"og:image\" property relative to the _static dir.\n\t\t'opengraph_image': 'path/to/your/opengraph-image.jpg',\n\n\t\t# Any custom additional OG tags\n\t\t'opengraph_tags': {\n\t\t\t'foo': 'bar', # will be rendered as \n\t\t},\n\n\t\t# The \"description\" meta tag will be created automatically, but\n\t\t# you can specify additional meta tags here.\n\t\t'meta_tags': {\n\t\t\t'foo': 'bar', # will be rendered as \n\t\t},\n\n\t\t# The value for \"description\" and \"og:description\" metatags.\n\t\t# If omitted, the value of \"motto\" will be used.\n\t\t'seo_description': 'This is an example of the Foundation Sphinx Theme output.',\n\n\t\t# Use this as the base for Open Graph URLs without trailing slash.\n\t\t'base_url': 'http://example.com',\n\n\t\t# If true a bar with Facebook, Google+ and Twitter social buttons will be displayed\n\t\t# underneath the header.\n\t\t'social_buttons': True,\n\n\t\t# ID of your Facebook app associated with the Facebook Like button.\n\t\t'facebook_app_id': '123456789',\n\n\t\t# A Twitter ID used for the via mention of the Twitter button.\n\t\t'twitter_id': 'FoundationSphinx',\n\n\t\t# Flattr button settings.\n\t\t'flattr_id': 'andypipkin', # Your Flattr ID\n\t\t'flattr_title': '', # If missing docstitle or title will be used.\n\t\t'flattr_description': '', # If missing seo_description or motto will be used.\n\t\t'flattr_tags': '', # Optional.\n\n\n\t\t# If \"author\" and \"copyright_year\" are set they will override the \"copyright\" setting.\n\n\t\t# Author's name.\n\t\t'author': 'Peter Hudec',\n\n\t\t# Author's link.\n\t\t'author_link': 'http://peterhudec.com',\n\n\t\t# Year to be used in the copyright statement.\n\t\t'copyright_year': '2013',\n\n\t\t# Author's Google+ id. If set a G+ authorship link will be added.\n\t\t'google_plus_id': '117034840853387702598',\n\n\n\t\t# Fork me on GitHub ribbon will be displayed if \"github_user\", \"github_repo\" and \"github_ribbon_image\" are set:\n\t\t# https://github.com/blog/273-github-ribbons\n\t\t# Ribbons are hidden on small screens!\n\n\t\t# Your GitHub ID.\n\t\t'github_user': 'foundation-sphinx-theme',\n\n\t\t# The repository slug.\n\t\t'github_repo': 'foundation-sphinx-theme',\n\n\t\t# Path to the ribbon image relative to the \"_static\" directory.\n\t\t'github_ribbon_image': 'my-github-ribbon.png',\n\n\t\t# Position of the ribbon \"left\" or \"right\".\n\t\t'github_ribbon_position': 'right',\n\t}", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/peterhudec/foundation-sphinx-theme", "keywords": "sphinx,reStructuredText,theme,foundation", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "foundation-sphinx-theme", "package_url": "https://pypi.org/project/foundation-sphinx-theme/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/foundation-sphinx-theme/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/peterhudec/foundation-sphinx-theme" }, "release_url": "https://pypi.org/project/foundation-sphinx-theme/0.0.3/", "requires_dist": null, "requires_python": null, "summary": "UNKNOWN", "version": "0.0.3" }, "last_serial": 1629853, "releases": { "0.0.3": [ { "comment_text": "", "digests": { "md5": "e4addeafff77ca9a0d4872d1d80c6c8c", "sha256": "9023a8cbc289ab260f3183715caeb684ad4ae2f56bbbeb0dc147f5d2796c2f12" }, "downloads": -1, "filename": "foundation-sphinx-theme-0.0.3.tar.gz", "has_sig": false, "md5_digest": "e4addeafff77ca9a0d4872d1d80c6c8c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 403021, "upload_time": "2015-07-12T11:59:52", "url": "https://files.pythonhosted.org/packages/51/c7/857dfa211ade8eed382bb74bc1bd0ed518416c75c8a6fa928403b9b5193f/foundation-sphinx-theme-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e4addeafff77ca9a0d4872d1d80c6c8c", "sha256": "9023a8cbc289ab260f3183715caeb684ad4ae2f56bbbeb0dc147f5d2796c2f12" }, "downloads": -1, "filename": "foundation-sphinx-theme-0.0.3.tar.gz", "has_sig": false, "md5_digest": "e4addeafff77ca9a0d4872d1d80c6c8c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 403021, "upload_time": "2015-07-12T11:59:52", "url": "https://files.pythonhosted.org/packages/51/c7/857dfa211ade8eed382bb74bc1bd0ed518416c75c8a6fa928403b9b5193f/foundation-sphinx-theme-0.0.3.tar.gz" } ] }