Skip to main content

Sphinx Theme for the StARLinG Lab.

Project description

A Sphinx Theme for StARLinG Lab 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.

Installation & Getting Started

  1. Clone the repository

$ git clone
$ python develop
  1. This repository uses itself as a theme. Build the documentation with Sphinx and open it with a browser.

$ 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.


Copyright © 2018, Alexander L. Hayes

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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starling_theme-0.1.4.tar.gz (3.3 kB view hashes)

Uploaded source

Built Distribution

starling_theme-0.1.4-py2.py3-none-any.whl (13.5 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page