diff --git a/CHANGELOG.md b/CHANGELOG.md index ae06900..dde45a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Added + +- Add project logo in SVG and WEBP formats + +### Changed + +- Use logo in documentation and README + ## [v3.0.0] - 2025-07-22 ### Added @@ -40,7 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Enhanced GitLab CI pipeline with automated release stages - Added type hints to commit message linting script -### Added (CI/CD) +### Added - Automated package building (wheel and source distribution) on tag push - GitLab release creation with changelog extraction @@ -64,9 +74,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Improve JATS list tag conversion with sequential processing to handle ordered and unordered lists more robustly - Standardize package imports and configure explicit exports -### Development +### Added -- Added pre-commit integration with ruff, bandit, and gitlint +- Pre-commit integration with ruff, bandit, and gitlint - Updated development dependencies to include gitlint - Enhanced developer workflow with automated code quality checks diff --git a/README.md b/README.md index 51c2e1a..7c3a409 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # doi2dataset +
+ doi2dataset logo +
+ ![pipeline](https://git.uni-due.de/cbm343e/doi2dataset/badges/main/pipeline.svg) ![coverage](https://git.uni-due.de/cbm343e/doi2dataset/badges/main/coverage.svg) diff --git a/docs/source/_static/doi2dataset_demo.webp b/docs/source/_static/doi2dataset_demo.webp deleted file mode 100644 index 67038ef..0000000 Binary files a/docs/source/_static/doi2dataset_demo.webp and /dev/null differ diff --git a/docs/source/_static/logo.svg b/docs/source/_static/logo.svg new file mode 100644 index 0000000..8a05622 --- /dev/null +++ b/docs/source/_static/logo.svg @@ -0,0 +1,58 @@ + + + + diff --git a/docs/source/_static/logo_300dpi.webp b/docs/source/_static/logo_300dpi.webp new file mode 100644 index 0000000..7520a94 Binary files /dev/null and b/docs/source/_static/logo_300dpi.webp differ diff --git a/docs/source/_static/logo_monochrome.svg b/docs/source/_static/logo_monochrome.svg new file mode 100644 index 0000000..a582f7f --- /dev/null +++ b/docs/source/_static/logo_monochrome.svg @@ -0,0 +1,73 @@ + + + + diff --git a/docs/source/_static/logo_monochrome_300dpi.webp b/docs/source/_static/logo_monochrome_300dpi.webp new file mode 100644 index 0000000..9790794 Binary files /dev/null and b/docs/source/_static/logo_monochrome_300dpi.webp differ diff --git a/docs/source/_static/logo_text.svg b/docs/source/_static/logo_text.svg new file mode 100644 index 0000000..41e4bbe --- /dev/null +++ b/docs/source/_static/logo_text.svg @@ -0,0 +1,96 @@ + + + +doi2dataset diff --git a/docs/source/_static/logo_text_300dpi.webp b/docs/source/_static/logo_text_300dpi.webp new file mode 100644 index 0000000..6437b2c Binary files /dev/null and b/docs/source/_static/logo_text_300dpi.webp differ diff --git a/docs/source/conf.py b/docs/source/conf.py index cfa5abd..cc979c1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,6 +43,14 @@ suppress_warnings = ['autodoc.import_object', 'ref.duplicate'] html_theme = "sphinx_rtd_theme" html_static_path = ['_static'] +# Theme options for RTD theme +html_theme_options = { + 'logo_only': False, +} + +# Logo configuration (use simple logo without text for theme integration) +html_logo = '_static/logo.svg' + # -- Options for multiversion ------------------------------------------------ # https://holzhaus.github.io/sphinx-multiversion/master/configuration.html diff --git a/docs/source/index.rst b/docs/source/index.rst index 56551d8..fa52ac9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,6 +3,11 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. image:: _static/logo.svg + :alt: doi2dataset logo + :align: center + :width: 400px + doi2dataset documentation =========================