Add logo

README.md

@@ -1,8 +1,14 @@
-# Visualization Core (vuecore) library
+<!---
+static path to be changed by its link after merging into the main branch: 
+https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuecore/main/docs/images/vuecore_logo.svg
+-->
+## ![VueCore Logo](./docs/images/vuecore_logo.svg)
 
-Visualization library for omics data.
+<p align="center">
+   VueCore is a Python package for creating interactive and static visualizations of multi-omics data
+</p>
 
-See also acore and vuegen.
+VueCore is part of a broader ecosystem of tools for multi-omics analysis, working in conjunction with [ACore][acore] and [VueGen][vuegen] to enable end-to-end data processing, visualization, and reporting.
 
 ## Installation
 
@@ -22,3 +28,6 @@ editable mode:
 # cd vuecore
 pip install -e '.[dev]'
 ```
+
+[vuegen]: https://github.com/Multiomics-Analytics-Group/vuegen
+[acore]: https://github.com/Multiomics-Analytics-Group/acore

docs/.gitignore

@@ -3,3 +3,6 @@ reference
 # builds
 _build
 jupyter_execute
+
+# VS Code
+.DS_Store

docs/conf.py

@@ -38,6 +38,7 @@
     "sphinx.ext.intersphinx",
     "sphinx_new_tab_link",
     "myst_nb",
+    "sphinx-copybutton",
 ]
 
 #  https://myst-nb.readthedocs.io/en/latest/computation/execute.html
@@ -99,8 +100,10 @@
 # https://github.com/executablebooks/MyST-NB/blob/master/docs/conf.py
 # html_title = ""
 html_theme = "sphinx_book_theme"
-# html_logo = "_static/logo-wide.svg"
-# html_favicon = "_static/logo-square.svg"
+# static path to be changed by its link after merging into the main branch:
+# https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuecore/main/docs/images/vuecore_logo.svg
+html_logo = "images/vuecore_logo.svg"
+html_favicon = "images/vuecore_logo.svg"
 html_theme_options = {
     "github_url": "https://github.com/Multiomics-Analytics-Group/vuecore",
     "repository_url": "https://github.com/Multiomics-Analytics-Group/vuecore",