doc: logo

README.md

@@ -1,4 +1,5 @@
-# dmlcloud
+![dmlcloud logo](./misc/logo/dmlcloud_color.svg)
+---------------
 [![](https://img.shields.io/pypi/v/dmlcloud)](https://pypi.org/project/dmlcloud/)
 [![](https://img.shields.io/github/actions/workflow/status/sehoffmann/dmlcloud/run_tests.yml?label=tests&logo=github)](https://github.com/sehoffmann/dmlcloud/actions/workflows/run_tests.yml)
 [![](https://img.shields.io/github/actions/workflow/status/sehoffmann/dmlcloud/run_linting.yml?label=lint&logo=github)](https://github.com/sehoffmann/dmlcloud/actions/workflows/run_linting.yml)

ci_requirements.txt

@@ -5,3 +5,4 @@ build
 pre-commit
 pytest
 sphinx
+sphinx-rtd-theme

doc/conf.py

@@ -6,6 +6,8 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+import dmlcloud
+
 project = 'dmlcloud'
 copyright = '2024, Sebastian Hoffmann'
 author = 'Sebastian Hoffmann'
@@ -18,6 +20,7 @@
     'sphinx.ext.duration',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',
 ]
 
 templates_path = ['_templates']
@@ -28,5 +31,6 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+html_logo = '../misc/logo/dmlcloud_light.png'