diff options
| author |   Max Magorsch <max@magorsch.de> | 2020-01-23 15:01:58 +0100 |
|---|---|---|
| committer | Max Magorsch <max@magorsch.de> | 2020-01-23 15:01:58 +0100 |
| commit | 144bda24c48e17f0ac3b19c90050de7b702456e7 (patch) | |
| tree | da09438ff9ddd9a5c802707c8cdc75143108b9b8 /README.md | |
| parent | Add a link to the github repository (diff) | |
| download | tyrian-sphinx-theme-144bda24c48e17f0ac3b19c90050de7b702456e7.tar.gz tyrian-sphinx-theme-144bda24c48e17f0ac3b19c90050de7b702456e7.tar.bz2 tyrian-sphinx-theme-144bda24c48e17f0ac3b19c90050de7b702456e7.zip | |
Make the license configurable
Add two new html_theme_options (license and license_link)
which can be used to configure the license that will be
displayed in the footer.
Further information about the option are included in the README.
By default the CC-BY-SA-4.0 will be used.
Resolves: #2
Signed-off-by: Max Magorsch <max@magorsch.de>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -10,6 +10,8 @@ A Sphinx theme based on Tyrian (the new unified gentoo.org theme). - [navigationlinks_top](#navigationlinks_top) - [navigationlinks_bottom](#navigationlinks_bottom) - [navigationlinks_navbar](#navigationlinks_navbar) + - [license](#license) + - [license_link](#license_link) - [Contributors](#contributors) ## Installation @@ -56,5 +58,15 @@ $ sphinx-build -b singlehtml ... - 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)
\ No newline at end of file |