Metadata-Version: 2.1
Name: sphinx-veldus-theme
Version: 0.0.3
Summary: Read the Docs theme for Sphinx
Home-page: https://github.com/DukeOfEtiquette/sphinx_veldus_theme
Author: Adam DuQuette
Author-email: duquetteadam@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: sphinx
Provides-Extra: dev
Requires-Dist: transifex-client ; extra == 'dev'
Requires-Dist: sphinxcontrib-httpdomain ; extra == 'dev'
Requires-Dist: bump2version ; extra == 'dev'

*******************
Veldus Sphinx Theme
*******************

.. .. image:: https://img.shields.io/pypi/v/sphinx_veldus_theme.svg
..    :target: https://pypi.python.org/pypi/sphinx_veldus_theme
..    :alt: Pypi Version
.. .. image:: https://travis-ci.org/readthedocs/sphinx_veldus_theme.svg?branch=master
..    :target: https://travis-ci.org/readthedocs/sphinx_veldus_theme
..    :alt: Build Status
.. .. image:: https://img.shields.io/pypi/l/sphinx_veldus_theme.svg
..    :target: https://pypi.python.org/pypi/sphinx_veldus_theme/
..    :alt: License
.. .. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest
..   :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
..   :alt: Documentation Status

This is a fork of the official `Read the Docs`_ theme for Sphinx_. See their `theme documentation`_ for more information.

.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org
.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/latest/

Installation
============

This theme is distributed on PyPI_ and can be installed with ``pip``:

.. code:: console

   $ pip install sphinx_veldus_theme

To use the theme in your Sphinx project, you will need to add the following to
your ``conf.py`` file:

.. code:: python

    import sphinx_veldus_theme

    extensions = [
        ...
        "sphinx_veldus_theme",
    ]

    html_theme = "sphinx_veldus_theme"

For more information read the full documentation on `installing the theme`_

.. _PyPI: https://pypi.python.org/pypi/sphinx_veldus_theme
.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html

Configuration
=============

This theme is highly customizable on both the page level and on a global level.
To see all the possible configuration options, read the documentation on
`configuring the theme`_.

.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html

Contributing
============

If you would like to help modify or translate the theme, you'll find more
information on contributing in our `contributing guide`_.

.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html


