From f0362a352b01b86e3984cadb374bea7cc7632908 Mon Sep 17 00:00:00 2001 From: "Felix T.J. Dietrich" Date: Tue, 21 May 2024 23:30:13 +0200 Subject: [PATCH] update logo and theme options for documentation --- README.md | 6 ++- docs/_static/css/style.css | 4 ++ docs/conf.py | 5 +++ docs/images/hammer.svg | 66 +++++++++++++++++++++++++++++ docs/images/logo.svg | 87 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 167 insertions(+), 1 deletion(-) create mode 100644 docs/images/hammer.svg create mode 100644 docs/images/logo.svg diff --git a/README.md b/README.md index 692c6c30..ee6b4685 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ -Hephaestus Logo +
+ Hephaestus Logo +
# Hephaestus Hephaestus - A Generative AI Mentor for Agile Software Development +Agile Hephaestus + ## Documentation The documentation can be found [here](https://ls1intum.github.io/Hephaestus/). \ No newline at end of file diff --git a/docs/_static/css/style.css b/docs/_static/css/style.css index 6d613065..465c416d 100644 --- a/docs/_static/css/style.css +++ b/docs/_static/css/style.css @@ -1,6 +1,10 @@ /* This import resolves when built */ @import url("theme.css"); +.wy-side-nav-search { + background-color: #e7d4fa; +} + .wy-body-for-nav .wy-nav-content { max-width: none; /* use full width */ } diff --git a/docs/conf.py b/docs/conf.py index 831fbccf..bf7d11b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,6 +51,11 @@ "github_version": "develop", "conf_py_path": "/docs/", } +html_logo = "images/logo.svg" +html_theme_options = { + 'logo_only': True, + 'display_version': False, +} html_style = 'css/style.css' html_static_path = ['_static'] diff --git a/docs/images/hammer.svg b/docs/images/hammer.svg new file mode 100644 index 00000000..c1bfa25c --- /dev/null +++ b/docs/images/hammer.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + diff --git a/docs/images/logo.svg b/docs/images/logo.svg new file mode 100644 index 00000000..253579a8 --- /dev/null +++ b/docs/images/logo.svg @@ -0,0 +1,87 @@ + + + + + + + + + + + + + + + + + + + + + +