From 144bda24c48e17f0ac3b19c90050de7b702456e7 Mon Sep 17 00:00:00 2001 From: Max Magorsch Date: Thu, 23 Jan 2020 15:01:58 +0100 Subject: 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 --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 49b5e12..878bf23 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3-65-gdbad