diff --git a/lightmotif-py/docs/_images/favicon.ico b/lightmotif-py/docs/_images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..2dbb4806c65aa618561a2d18f3a547d41d4ec982 Binary files /dev/null and b/lightmotif-py/docs/_images/favicon.ico differ diff --git a/lightmotif-py/docs/_images/logo-dark.png b/lightmotif-py/docs/_images/logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..554d798e2f97783c14986f16eb6fe4045cda2b73 Binary files /dev/null and b/lightmotif-py/docs/_images/logo-dark.png differ diff --git a/lightmotif-py/docs/_images/logo-light.png b/lightmotif-py/docs/_images/logo-light.png new file mode 100644 index 0000000000000000000000000000000000000000..15dc057f9b080813f1225584a31135291c308ca1 Binary files /dev/null and b/lightmotif-py/docs/_images/logo-light.png differ diff --git a/lightmotif-py/docs/conf.py b/lightmotif-py/docs/conf.py index c59c9604c72d25154640263df6e48e6a92f1de0a..863dd348ed28c62a6629e7719ab2ff0b07261cf1 100644 --- a/lightmotif-py/docs/conf.py +++ b/lightmotif-py/docs/conf.py @@ -132,8 +132,8 @@ html_theme_options = { ], "logo": { "text": "LightMotif", - # "image_light": "_images/logo.png", - # "image_dark": "_images/logo.png", + "image_light": "_images/logo-light.png", + "image_dark": "_images/logo-dark.png", }, "navbar_start": ["navbar-logo", "version-switcher"], "navbar_align": "left", @@ -152,7 +152,7 @@ html_context = { "doc_path": "docs", } -# html_favicon = '_images/favicon.ico' +html_favicon = '_images/favicon.ico' # -- Options for HTMLHelp output --------------------------------------------- diff --git a/lightmotif-py/docs/index.rst b/lightmotif-py/docs/index.rst index 85810f606c901157bf75894f8e09455b2018ebd9..757e8c7d8e8015cad3108647ae5ac4393fa14978 100644 --- a/lightmotif-py/docs/index.rst +++ b/lightmotif-py/docs/index.rst @@ -3,11 +3,20 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -LightMotif |Stars| -================== +|Dark| |Light| LightMotif |Stars| +================================= + +.. |Dark| image:: _images/logo-dark.png + :class: only-dark + :scale: 50% + +.. |Light| image:: _images/logo-light.png + :class: only-light + :scale: 50% .. |Stars| image:: https://img.shields.io/github/stars/althonos/lightmotif.svg?style=social&maxAge=3600&label=Star :target: https://github.com/althonos/lightmotif/stargazers + :class: dark-light *A lightweight* `platform-accelerated <https://en.wikipedia.org/wiki/Single_instruction,_multiple_data>`_ *library for* `biological motif <https://en.wikipedia.org/wiki/Sequence_motif>`_ *scanning using* `position weight matrices <https://en.wikipedia.org/wiki/Position_weight_matrix>`_. @@ -74,6 +83,7 @@ Position weight matrices are often viewed as `sequence logos <https://en.wikiped .. image:: https://raw.githubusercontent.com/althonos/lightmotif/main/docs/_static/prodoric_logo_mx000274.svg :target: https://www.prodoric.de/matrix/MX000274.html + :class: dark-light The ``lightmotif`` library provides a Python module to run very efficient searches for a motif encoded in a position weight matrix. The position