diff options
| author | Unai Martinez-Corral <38422348+umarcor@users.noreply.github.com> | 2023-03-04 11:08:58 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-04 11:08:58 +0000 |
| commit | 0d2363dc400eebbbdb06cd93a2ae87e4bfaaf1e8 (patch) | |
| tree | 98ea7e4bc2ba583cea1d2c5fa2f7730652926416 /doc/conf.py | |
| parent | 06ac73c53373d22b5ec7737d619a1556671bb780 (diff) | |
| parent | 7e2fba9abe23e9b627423768dd33ec4886403ba5 (diff) | |
| download | ghdl-0d2363dc400eebbbdb06cd93a2ae87e4bfaaf1e8.tar.gz ghdl-0d2363dc400eebbbdb06cd93a2ae87e4bfaaf1e8.tar.bz2 ghdl-0d2363dc400eebbbdb06cd93a2ae87e4bfaaf1e8.zip | |
doc: update (#2370)
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/doc/conf.py b/doc/conf.py index dbe43d056..cc84ade50 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 @@ -166,12 +189,9 @@ extensions = [ 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', - # BuildTheDocs extensions 'btd.sphinx.autoprogram', - # Other extensions -# 'recommonmark', 'exec', 'sphinx_fontawesome', 'sphinx_autodoc_typehints', |