From b15ac73d5a7c0eb020aceac78fabcbd4d023fa28 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Wed, 2 Sep 2026 16:09:56 +0100 Subject: [PATCH 1/3] feat: include dark and light mode logos within `docs` and `README.md` --- README.md | 6 +++++- docs/source/_static/logos/prepmd-logo-black-text.svg | 1 + docs/source/_static/logos/prepmd-logo-white-text.svg | 1 + docs/source/conf.py | 8 ++++++-- 4 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 docs/source/_static/logos/prepmd-logo-black-text.svg create mode 100644 docs/source/_static/logos/prepmd-logo-white-text.svg diff --git a/README.md b/README.md index bdbd7e2..09a2fcd 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,11 @@ A utility to automatically prepare structures from the PDB for molecular dynamics simulation and perform minimisations and simple MD simulations. ## Example usage -demo +

+ prepmd logo + prepmd logo +

+ ## Features * Automatically download structures, sequences and metadata from the PDB, PDB-REDO, EMDB and UNIPROT diff --git a/docs/source/_static/logos/prepmd-logo-black-text.svg b/docs/source/_static/logos/prepmd-logo-black-text.svg new file mode 100644 index 0000000..e496d91 --- /dev/null +++ b/docs/source/_static/logos/prepmd-logo-black-text.svg @@ -0,0 +1 @@ +prepmd \ No newline at end of file diff --git a/docs/source/_static/logos/prepmd-logo-white-text.svg b/docs/source/_static/logos/prepmd-logo-white-text.svg new file mode 100644 index 0000000..c7e3d47 --- /dev/null +++ b/docs/source/_static/logos/prepmd-logo-white-text.svg @@ -0,0 +1 @@ +prepmd \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index b7c0c99..3a3fdee 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,7 +9,6 @@ version = "1.0.0" release = "1.0.0" -html_logo = "https://github.com/CCPBioSim/branding/raw/refs/heads/main/logos/prepmd/prepmd-logo-black-text.svg" # -- General configuration --------------------------------------------------- @@ -67,7 +66,12 @@ # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# -- Options for HTML output ------------------------------------------------- html_theme = "furo" + +html_theme_options = { + "light_logo": "logos/prepmd-logo-black-text.svg", + "dark_logo": "logos/prepmd-logo-white-text.svg", +} + html_static_path = ["_static"] From d512ecbf1e381d22103bd7988892702a660f74f8 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Wed, 2 Sep 2026 16:12:19 +0100 Subject: [PATCH 2/3] chore: remove hardcoded `version` and `release` numbers within `docs/source/conf.py` --- docs/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3a3fdee..b4dacf9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,8 +6,8 @@ copyright = "2026, CCPBioSim" author = "CCPBioSim" -version = "1.0.0" -release = "1.0.0" +version = "" +release = "" # -- General configuration --------------------------------------------------- From a7303457668da4a6cda1369296b331ed6e59bfa4 Mon Sep 17 00:00:00 2001 From: harryswift01 Date: Wed, 2 Sep 2026 16:14:49 +0100 Subject: [PATCH 3/3] feat: update `docs` logos with non text version --- docs/source/_static/logos/prepmd-logo-black.svg | 1 + docs/source/_static/logos/prepmd-logo-white.svg | 1 + docs/source/conf.py | 4 ++-- 3 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 docs/source/_static/logos/prepmd-logo-black.svg create mode 100644 docs/source/_static/logos/prepmd-logo-white.svg diff --git a/docs/source/_static/logos/prepmd-logo-black.svg b/docs/source/_static/logos/prepmd-logo-black.svg new file mode 100644 index 0000000..269ab49 --- /dev/null +++ b/docs/source/_static/logos/prepmd-logo-black.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/source/_static/logos/prepmd-logo-white.svg b/docs/source/_static/logos/prepmd-logo-white.svg new file mode 100644 index 0000000..59a559e --- /dev/null +++ b/docs/source/_static/logos/prepmd-logo-white.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index b4dacf9..3e74e26 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -70,8 +70,8 @@ html_theme = "furo" html_theme_options = { - "light_logo": "logos/prepmd-logo-black-text.svg", - "dark_logo": "logos/prepmd-logo-white-text.svg", + "light_logo": "logos/prepmd-logo-black.svg", + "dark_logo": "logos/prepmd-logo-white.svg", } html_static_path = ["_static"]