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.
- Clone the repository
$ git clone git@github.com:starling-lab/starling-theme.git
$ python setup.py develop
- 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
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.