From aad1b51d0cb92dca0f9b1393452ff1922d28be83 Mon Sep 17 00:00:00 2001 From: Patrick Schuenke Date: Mon, 16 Dec 2024 15:51:07 +0100 Subject: [PATCH] Add logo to readme and docs --- README.md | 6 +- docs/source/_static/logo.svg | 218 +++++++++++++++++++++++++++++ docs/source/_static/logo_white.svg | 218 +++++++++++++++++++++++++++++ docs/source/conf.py | 3 +- docs/source/index.rst | 5 + 5 files changed, 446 insertions(+), 4 deletions(-) create mode 100644 docs/source/_static/logo.svg create mode 100644 docs/source/_static/logo_white.svg diff --git a/README.md b/README.md index c02b80deb..49d7e2c3d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# MRpro +

+MRpro logo +


![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -84,5 +86,3 @@ We are looking forward to your contributions via Pull-Requests. 4. Setup pre-commit hook: ``` pre-commit install ``` Please look at our [contributor guide](https://ptb-mr.github.io/mrpro/contributor_guide.html) for more information on the repository structure, naming conventions, and other useful information. - - diff --git a/docs/source/_static/logo.svg b/docs/source/_static/logo.svg new file mode 100644 index 000000000..29c7eeabf --- /dev/null +++ b/docs/source/_static/logo.svg @@ -0,0 +1,218 @@ + + + +MRpr diff --git a/docs/source/_static/logo_white.svg b/docs/source/_static/logo_white.svg new file mode 100644 index 000000000..d0d5b3527 --- /dev/null +++ b/docs/source/_static/logo_white.svg @@ -0,0 +1,218 @@ + + + +MRpr diff --git a/docs/source/conf.py b/docs/source/conf.py index 02f75262b..764b75f13 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -60,9 +60,10 @@ html_show_sphinx = False html_static_path = ['_static'] html_css_files = ['custom.css'] +html_logo = '_static/logo_white.svg' html_sidebars = {'**': ['search-field', 'sidebar-nav-bs']} html_theme_options = { - 'logo': {'text': name}, + 'logo_only': True, 'pygment_light_style': 'default', 'pygment_dark_style': 'github-dark', 'show_toc_level': 3, diff --git a/docs/source/index.rst b/docs/source/index.rst index a08619105..294847210 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,10 @@ .. MRpro documentation +.. image:: _static/logo.svg + :align: center + :width: 400 +| + Welcome to MRpro's documentation! =================================