Metadata-Version: 2.1
Name: starling-theme
Version: 0.1.2
Summary: Sphinx Theme for the StARLinG Lab.
Home-page: https://github.com/batflyer/
Author: Alexander L. Hayes
Author-email: alexander@batflyer.net
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Documentation
Requires-Dist: sphinx

=====================
StARLinG Sphinx Theme
=====================

A Sphinx Theme for `StARLinG Lab <https://starling.utdallas.edu>`_ Documentation.

There are already a lot of tools that support writing and building documentation with Sphinx. This component makes it easy to generate ``.html`` pages that meld seamlessly with `StARLinG's Webpage <https://github.com/starling-lab/starling.utdallas.edu>`_.

.. image:: documentation/source/_static/starling_theme_screenshot_0.1.1.png

Installation & Getting Started
------------------------------

1. Clone the repository

.. code-block:: bash

  $ git clone git@github.com:batflyer/starling_theme.git
  $ python setup.py develop

2. This repository uses itself as a theme. Build the documentation with Sphinx and open it with a browser.

.. code-block:: bash

  $ cd documentation
  $ make html
  $ firefox build/html/index.html

Project State & Current Goals
-----------------------------

This repository is in an *Alpha Phase*. The goal is to create a documentation theme which blends seamlessly with the StARLinG Website, but exactly how this may be achieved is up for debate.

Open Problems are tracked through the `Issues Page <https://github.com/batflyer/starling_theme/issues/>`_.

License
-------

Copyright © 2018, Alexander L. Hayes

Distributed under the terms of the MIT License. See the LICENSE at the base of the repository for details.


