https://github.com/hayesall/starling-theme

A Sphinx Theme for StARLinG Lab Documentation
https://github.com/hayesall/starling-theme

docs documentation-generator sphinx-theme starling-lab

Last synced: 28 days ago
JSON representation

A Sphinx Theme for StARLinG Lab Documentation

• Host: GitHub
• URL: https://github.com/hayesall/starling-theme
• Owner: hayesall
• License: other
• Created: 2018-11-03T01:35:41.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-13T19:19:35.000Z (over 5 years ago)
• Last Synced: 2024-09-24T11:06:21.472Z (about 2 months ago)
• Topics: docs, documentation-generator, sphinx-theme, starling-lab
• Language: HTML
• Homepage: https://starling-theme.readthedocs.io/en/stable/
• Size: 158 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - hayesall/starling-theme - A Sphinx Theme for StARLinG Lab Documentation (others)

README

        
=====================

StARLinG Sphinx Theme

=====================

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 `_.

.. raw:: html

  


    

  


Installation & Getting Started

------------------------------

1. Clone the repository

.. code-block:: bash

  $ git clone [email protected]:starling-lab/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 `_.

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.