Sphinx Theme for the StARLinG Lab.
Project description
A Sphinx Theme for StARLinG Lab Documentation.
Installation & Getting Started
Clone the repository
$ git clone git@github.com:batflyer/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
Project State & Current Goals
This repository is in an Exploratory 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:
Better navigation (wy-nav-side and wy-grid-for-nav are currently dumped as links on each page rather than having a navigation menu).
Standardize the color scheme (rather than defaulting to rtd_sphinx_theme colors).
Unit tests for building certain page elements.
Documentation for building/deploying.
[Maybe]: Hook into the starling-lab/starling.utdallas.edu repository to automatically copy portions of the header and footer.
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.
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
Built Distribution
Hashes for starling_theme-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08a9a0fe0c2dbc461ec79d2f9a0ca90b8e7a826ec896dd6e7beaaa362717a4b2 |
|
MD5 | 23faf9fd43e09f60fbff8df8ed515b80 |
|
BLAKE2b-256 | 48d3d02f10cd31526f132caeb8ed41113ec2d174ae50d93b64a37444610f90df |