Metadata-Version: 1.2
Name: sphinx-foundation-theme
Version: 0.6.0
Summary: A Sphinx HTML theme that uses Zurb foundation-sites.
Home-page: https://thewtex.github.io/sphinx-foundation-theme/
License: UNKNOWN
Author: Matt McCormick
Author-email: matt.mccormick@kitware.com
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: sphinx

=======================
Sphinx Foundation Theme
=======================

.. image:: https://img.shields.io/pypi/v/sphinx-foundation-theme.svg?maxAge=2592000
    :target: https://pypi.python.org/pypi/sphinx-foundation-theme

.. image:: https://img.shields.io/pypi/dm/sphinx-foundation-theme.svg?maxAge=2592000
    :target: https://pypi.python.org/pypi/sphinx-foundation-theme

.. image:: https://img.shields.io/circleci/project/github/thewtex/sphinx-foundation-theme/master.svg
    :target: https://circleci.com/gh/thewtex/sphinx-foundation-theme/tree/master

.. image:: https://img.shields.io/github/stars/thewtex/sphinx-foundation-theme.svg?style=social&label=Star
    :target: https://github.com/thewtex/sphinx-foundation-theme

A `Sphinx <http://www.sphinx-doc.org/>`_ documentation generator theme that
uses `Zurb <http://foundation.zurb.com/>`_
`foundation-sites <http://foundation.zurb.com/sites.html>`_ CSS / JavaScript
for presentation.


Motivation
----------

Foundation is

- Accessible (508 compliant)
- Easy to theme via SASS settings
- `Responsive <https://en.wikipedia.org/wiki/Responsive_web_design>`_ and mobile friendly
- Readable and semantic
- Quick to download
- A fairly complete set of web page and user interface components
- Open source

Sphinx has

- Wide adoption in the scientific computing community
- Separation of content and style
- Support for equations
- Output in many formats
- Powerful indexing and cross referencing
- Extensibility
- An active open source community


Documentation
-------------

For more information and an example, see the `project documentation
<https://thewtex.github.io/sphinx-foundation-theme/>`_.


Inspired by
-----------

- `sphinx-bootstrap-theme <https://ryan-roemer.github.io/sphinx-bootstrap-theme/>`_
- `foundation-sphinx-theme
  <https://github.com/peterhudec/foundation-sphinx-theme>`_


