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-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-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/_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 b7c0c99..3e74e26 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,10 +6,9 @@ copyright = "2026, CCPBioSim" author = "CCPBioSim" -version = "1.0.0" -release = "1.0.0" +version = "" +release = "" -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.svg", + "dark_logo": "logos/prepmd-logo-white.svg", +} + html_static_path = ["_static"]