diff --git a/README.md b/README.md index e83c30a6..8ecd64ab 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ # janus-core +![logo][logo] Tools for machine learnt interatomic potentials ## Features in development @@ -200,3 +201,4 @@ Contributors to this project were funded by [license-link]: https://opensource.org/licenses/BSD-3-Clause [doi-link]: https://zenodo.org/badge/latestdoi/754081470 [doi-badge]: https://zenodo.org/badge/754081470.svg +[logo]: https://raw.githubusercontent.com/stfc/janus-core/main/docs/source/images/janus-core.png diff --git a/docs/source/conf.py b/docs/source/conf.py index ddc38ad1..43969051 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -114,6 +114,7 @@ html_theme = "furo" html_title = f"janus-core v{release}" +html_logo = "images/janus-core.png" html_theme_options = { "source_repository": "https://github.com/stfc/janus-core/", "source_branch": "main", diff --git a/docs/source/images/janus-core.png b/docs/source/images/janus-core.png new file mode 100644 index 00000000..eca8dc1a Binary files /dev/null and b/docs/source/images/janus-core.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index 565a4e58..6639450e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,6 +6,10 @@ Welcome to janus-core's documentation! ====================================== +.. image:: images/janus-core.png + :height: 100px + :target: https://github.com/stfc/janus-core/ + .. toctree:: :maxdepth: 2 :caption: Contents: