add logo and copybutton (#751)

* add logo and copybutton

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* update README

* Update pyproject.toml

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

README.md

@@ -1,17 +1,28 @@
+
+
+
+
+<div align="center">
+
+![Logo](https://raw.githubusercontent.com/zincware/ZnDraw/refs/heads/docs/docs/source/_static/zndraw-light.svg#gh-light-mode-only)
+![Logo](https://raw.githubusercontent.com/zincware/ZnDraw/refs/heads/docs/docs/source/_static/zndraw-dark.svg#gh-dark-mode-only)
+
 [![zincware](https://img.shields.io/badge/Powered%20by-zincware-darkcyan)](https://github.com/zincware)
 [![PyPI version](https://badge.fury.io/py/zndraw.svg)](https://badge.fury.io/py/zndraw)
 [![DOI](https://img.shields.io/badge/arXiv-2402.08708-red)](https://arxiv.org/abs/2402.08708)
 [![codecov](https://codecov.io/gh/zincware/ZnDraw/graph/badge.svg?token=3GPCKH1BBX)](https://codecov.io/gh/zincware/ZnDraw)
 [![Discord](https://img.shields.io/discord/1034511611802689557)](https://discord.gg/7ncfwhsnm4)
+[![Documentation Status](https://readthedocs.org/projects/zndraw/badge/?version=latest)](https://zndraw.readthedocs.io/en/latest/?badge=latest)
 !['Threejs](https://img.shields.io/badge/threejs-black?style=for-the-badge&logo=three.js&logoColor=white)
 
-# ZnDraw
+</div>
 
+# ZnDraw - Display and Edit Molecules
 Welcome to ZnDraw, a powerful tool for visualizing and interacting with your trajectories.
 
 ## Installation
 
-It is recommended to install ZnDraw from PyPi via:
+You can install ZnDraw directly from PyPi via:
 
 ```bash
 pip install zndraw

docs/source/conf.py

@@ -18,6 +18,7 @@
 
 extensions = [
     "nbsphinx",
+    "sphinx_copybutton",
 ]
 
 templates_path = ["_templates"]
@@ -29,3 +30,25 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+
+html_theme_options: dict = {
+    "light_logo": "zndraw-light.svg",
+    "dark_logo": "zndraw-dark.svg",
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/zincware/zndraw",
+            "html": "",
+            "class": "fa-brands fa-github fa-2x",
+        },
+    ],
+    "source_repository": "https://github.com/zincware/zndraw",
+    "source_branch": "main",
+    "source_directory": "docs/source/",
+    "navigation_with_keys": True,
+}
+
+# font-awesome logos
+html_css_files = [
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
+]

pyproject.toml

@@ -48,6 +48,7 @@ znh5md = {version = "^0.3"}
 sphinx = "^8.1.3"
 furo = "^2024.8.6"
 nbsphinx = "^0.9.5"
+sphinx-copybutton = "^0.5.2"
 
 [build-system]
 requires = ["poetry-core"]
@@ -71,4 +72,4 @@ select = ["I", "F"]
 addopts = "-m 'not chrome'"
 
 [tool.codespell]
-skip = "poetry.lock"
+skip = "*.svg,*.lock"