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
Clone the repository
$ git clone git@github.com:starling-lab/starling-theme.git
$ python setup.py developThis 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.htmlProject 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.
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.
1 maintainer
Metadata
1 maintainer
Release files for starling-theme 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| starling_theme-0.1.4.tar.gz | 3.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| starling_theme-0.1.4-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 16.8 kB
Release files / starling_theme-0.1.4.tar.gz
| Download URL | starling_theme-0.1.4.tar.gz |
|---|---|
| Size | 3.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2ddb800e8d23c8c81d5aed70de959f706eb118d9742c053ef23be3aa6cbb7f1
|
|
BLAKE2b-256 checksum How to use checksums |
eb2ff7b28e7857ad34ea98481702105c0406c13370153b9d3e8e00258c8655f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
Release files / starling_theme-0.1.4-py2.py3-none-any.whl
| Download URL | starling_theme-0.1.4-py2.py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
22d5391de6ce72afa78f8cf43fa182c2ed534e19bf7a1a8365cdad38d2fdabff
|
|
BLAKE2b-256 checksum How to use checksums |
03ac43f1da0a9908a734629dd11078e0f36e299c78079149b776c4300439f7ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
|
