aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2023-03-03 14:34:17 +0100
committerumarcor <unai.martinezcorral@ehu.eus>2023-03-03 15:28:09 +0100
commit8e9f268fbd6060039403e30b489a233d24047d4d (patch)
treee13618e357aca637300223f5141a589470b39055 /doc
parentc22d8419d4a9a5e93f13ae5027728295b3e691f3 (diff)
downloadghdl-8e9f268fbd6060039403e30b489a233d24047d4d.tar.gz
ghdl-8e9f268fbd6060039403e30b489a233d24047d4d.tar.bz2
ghdl-8e9f268fbd6060039403e30b489a233d24047d4d.zip
doc/conf: add html_theme_options and html_css_files
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
index dbe43d056..5c845c7f8 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,5 +1,6 @@
# -*- coding: utf-8 -*-
import sys
+from os import environ
from os.path import abspath
from pathlib import Path
from json import loads as json_loads
@@ -87,6 +88,28 @@ if ctx.is_file():
html_theme = "furo"
+html_css_files = [
+ "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
+ "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css",
+ "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
+]
+
+html_theme_options = {
+ "source_repository": "https://github.com/ghdl/ghdl",
+ "source_branch": environ.get("GITHUB_REF_NAME", "main"),
+ "source_directory": "doc",
+ "footer_icons": [
+ {
+ "name": "GitHub ghdl/ghdl",
+ "url": "https://github.com/ghdl/ghdl",
+ "html": "",
+ "class": "fa-solid fa-brands fa-github",
+ },
+ ],
+}
+
+html_title = release
+
html_static_path = ['_static']
# '/public' will contain the output from gnatdoc
html_extra_path = [str(Path(__file__).resolve().parent.parent / 'public')] # FIXME: if not exist, create directory