tyrian-sphinx-theme 0.0.9
A Tyrian based Sphinx theme for Gentoo
Requires Python: >=3.8

<p align="center"><img width=17.5% src="https://raw.githubusercontent.com/mmagorsc/tyrian_sphinx_theme/master/docs/tyrian_sphinx_theme_raw.png"></p>
<p align="center"><img width=60% src="https://raw.githubusercontent.com/mmagorsc/tyrian_sphinx_theme/master/docs/tyrian_sphinx_theme_label.png"></p>

<p align="center">
<a href="https://www.python.org/" ><img src="https://img.shields.io/badge/python-2.6%2B-blue.svg"></a>
<a> <img src="https://github.com/mmagorsc/tyrian_sphinx_theme/workflows/Upload%20Python%20Package/badge.svg"></a>
<a href="https://pypi.org/project/tyrian-sphinx-theme/"><img src="https://badge.fury.io/py/tyrian-sphinx-theme.svg" alt="PyPI version" height="18"></a>
<a href="#contributing"> <img src="https://img.shields.io/badge/contributions-welcome-orange.svg"></a>
<a href="https://opensource.org/licenses/BSD-2-Clause"><img src="https://img.shields.io/badge/license-BSD-blue.svg"></a>
</p>

## Table Of Contents 

- [Basic Overview](#basic-overview)
- [Installation](#installation)
- [Configuration](#configuration)
    - [builders](#builders)
    - [sidebar](#sidebar)
    - [navigationlinks_top](#navigationlinks_top)
    - [navigationlinks_bottom](#navigationlinks_bottom)
    - [navigationlinks_navbar](#navigationlinks_navbar)
    - [license](#license)
    - [license_link](#license_link)
- [Contributors](#contributors)
- [Contributing](#contributing)

## Basic Overview

A Sphinx theme based on Tyrian (the new unified gentoo.org theme). 

[![Screenshot](https://raw.githubusercontent.com/mmagorsc/tyrian_sphinx_theme/master/docs/screenshot.png)](https://projects.gentoo.org/qa/policy-guide/)

## Installation
You can use pip to install the theme: 
``` shell
$ pip install tyrian-sphinx-theme
```

## Configuration
The appereance of the theme can be adjusted using different builders as well as further html_theme_options:

### builders

It is possible to use two different builders: 
- html-builder *(default)*: Creates multiple pages, i.e. one page per file
- singlehtml-builder: Creates a single large page, containing the whole content

You can specify the builder using sphinx command line options like: 
```
$ sphinx-build -b singlehtml ...
```

### sidebar

- right *(default)*: display the sidebar on the right side of the page
- left: display the sidebar on the left side of the page
- none: don't display the sidebar on the page at all

### navigationlinks_top

- short: display the links using "<< >>"
- long: display the links using "<< chapter-heading chapter-heading >>"
- none *(default)*: don't display the navigation links on top at all
    
### navigationlinks_bottom

- short: display the links using "<< >>"
- long *(default)*:  display the links using "<< chapter-heading chapter-heading >>"
- none: don't display the navigation links at the bottom at all
    
### navigationlinks_navbar

- short: display the links using "<< >>"
- long:  display the links using "<< chapter-heading chapter-heading >>"
- none *(default)*: don't display the navigation links in the navbar at all

### license

- the license that will be display in the footer
- CC-BY-SA-4.0 *(default)*

### license_link

- the link to the license that will be used when clicking on the license in the footer
- https://creativecommons.org/licenses/by-sa/4.0/ *(default)*

## Contributors
* [Max Magorsch](mailto:max@magorsch.de)

## Contributing

Contributions are welcome. You have an idea, suggestion for improvement or have found a bug? Just create an issue or send a pull request.