diff --git a/README.md b/README.md index f0e9db0..59825a0 100644 --- a/README.md +++ b/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) diff --git a/ci_requirements.txt b/ci_requirements.txt index a3c7096..775d288 100644 --- a/ci_requirements.txt +++ b/ci_requirements.txt @@ -5,3 +5,4 @@ build pre-commit pytest sphinx +sphinx-rtd-theme diff --git a/doc/conf.py b/doc/conf.py index 3e44836..80dbc79 100644 --- a/doc/conf.py +++ b/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' diff --git a/misc/logo/dmlcloud_color.png b/misc/logo/dmlcloud_color.png new file mode 100644 index 0000000..f6d2aef Binary files /dev/null and b/misc/logo/dmlcloud_color.png differ diff --git a/misc/logo/dmlcloud_color.svg b/misc/logo/dmlcloud_color.svg new file mode 100644 index 0000000..9509954 --- /dev/null +++ b/misc/logo/dmlcloud_color.svg @@ -0,0 +1,81 @@ + + + + + + + + + + + dmlcloud + + + + + diff --git a/misc/logo/dmlcloud_dark.png b/misc/logo/dmlcloud_dark.png new file mode 100644 index 0000000..4bc7ce8 Binary files /dev/null and b/misc/logo/dmlcloud_dark.png differ diff --git a/misc/logo/dmlcloud_dark.svg b/misc/logo/dmlcloud_dark.svg new file mode 100644 index 0000000..e7f9e26 --- /dev/null +++ b/misc/logo/dmlcloud_dark.svg @@ -0,0 +1,81 @@ + + + + + + + + + + + dmlcloud + + + + + diff --git a/misc/logo/dmlcloud_dark2.png b/misc/logo/dmlcloud_dark2.png new file mode 100644 index 0000000..c8c319e Binary files /dev/null and b/misc/logo/dmlcloud_dark2.png differ diff --git a/misc/logo/dmlcloud_dark2.svg b/misc/logo/dmlcloud_dark2.svg new file mode 100644 index 0000000..d8618f5 --- /dev/null +++ b/misc/logo/dmlcloud_dark2.svg @@ -0,0 +1,81 @@ + + + + + + + + + + + dmlcloud + + + + + diff --git a/misc/logo/dmlcloud_light.png b/misc/logo/dmlcloud_light.png new file mode 100644 index 0000000..526ee49 Binary files /dev/null and b/misc/logo/dmlcloud_light.png differ diff --git a/misc/logo/dmlcloud_light.svg b/misc/logo/dmlcloud_light.svg new file mode 100644 index 0000000..14d1dba --- /dev/null +++ b/misc/logo/dmlcloud_light.svg @@ -0,0 +1,51 @@ + + + + + + + + + + dmlcloud + + + + +