From 7391c4a04f6104711587b4061fbd28fe541d2435 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Tue, 7 Mar 2023 18:05:22 +0100 Subject: [PATCH 1/2] docs: minor changes --- README.md | 12 ------------ docs/README.md | 14 ++++++++++---- docs/reference/generate_reference_pages.py | 6 ++++-- mkdocs.yml | 6 +++--- 4 files changed, 17 insertions(+), 21 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 335e9bc0d..000000000 --- a/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Safe-DS Stdlib - -[![PyPI](https://img.shields.io/pypi/v/safe-ds)](https://pypi.org/project/safe-ds/) -[![Main](https://github.com/Safe-DS/Stdlib/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Stdlib/actions/workflows/main.yml) -[![codecov](https://codecov.io/gh/Safe-DS/Stdlib/branch/main/graph/badge.svg?token=HVRP1633B1)](https://codecov.io/gh/Safe-DS/Stdlib) -[![Documentation Status](https://readthedocs.org/projects/safe-ds-stdlib/badge/?version=latest)](https://safe-ds-stdlib.readthedocs.io/en/latest/?badge=latest) - -A user-friendly library for Data Science in Python. - -You can find the full documentation [here][docs]. - -[docs]: https://safe-ds-stdlib.readthedocs.io/en/latest/ diff --git a/docs/README.md b/docs/README.md index b64a25a4b..335e9bc0d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,12 @@ -# Safe-DS Python Library +# Safe-DS Stdlib -* [Tutorials][tutorials]: Detailed explanations how to use specific parts of the library. -* API Reference (link in navigation bar): An overview of the API of this library. +[![PyPI](https://img.shields.io/pypi/v/safe-ds)](https://pypi.org/project/safe-ds/) +[![Main](https://github.com/Safe-DS/Stdlib/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Stdlib/actions/workflows/main.yml) +[![codecov](https://codecov.io/gh/Safe-DS/Stdlib/branch/main/graph/badge.svg?token=HVRP1633B1)](https://codecov.io/gh/Safe-DS/Stdlib) +[![Documentation Status](https://readthedocs.org/projects/safe-ds-stdlib/badge/?version=latest)](https://safe-ds-stdlib.readthedocs.io/en/latest/?badge=latest) -[tutorials]: tutorials/README.md +A user-friendly library for Data Science in Python. + +You can find the full documentation [here][docs]. + +[docs]: https://safe-ds-stdlib.readthedocs.io/en/latest/ diff --git a/docs/reference/generate_reference_pages.py b/docs/reference/generate_reference_pages.py index 3439c6554..c77277767 100644 --- a/docs/reference/generate_reference_pages.py +++ b/docs/reference/generate_reference_pages.py @@ -7,6 +7,9 @@ import mkdocs_gen_files +root = "src" +package = "safeds" + def list_class_and_function_names_in_module(module_name: str) -> list[str]: """ @@ -20,7 +23,6 @@ def list_class_and_function_names_in_module(module_name: str) -> list[str]: nav = mkdocs_gen_files.Nav() -root = "src" for path in sorted(Path(root).rglob("__init__.py")): module_path = path.relative_to(root).with_suffix("") @@ -29,7 +31,7 @@ def list_class_and_function_names_in_module(module_name: str) -> list[str]: # Skip demos, tests, etc. parts = tuple(module_path.parts) - if parts[0] != "safeds": + if parts[0] != package: continue # Remove the final "__init__" part diff --git a/mkdocs.yml b/mkdocs.yml index 5566dd62e..97d69273b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Safe-DS Python Library +site_name: Safe-DS Stdlib repo_url: https://github.com/Safe-DS/Stdlib repo_name: Safe-DS/Stdlib @@ -11,8 +11,8 @@ nav: theme: name: material - logo: assets/logo.svg - favicon: assets/logo.svg + logo: https://raw.githubusercontent.com/Safe-DS/.github/main/branding/logo_rounded.svg + favicon: https://raw.githubusercontent.com/Safe-DS/.github/main/branding/logo_rounded.svg palette: # Palette toggle for light mode - scheme: default From 4c51a7a299c1ff4592e464b33754fabee98045e4 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Tue, 7 Mar 2023 18:15:18 +0100 Subject: [PATCH 2/2] docs: use indigo in dark mode too --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 97d69273b..f6acca7eb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,8 +27,8 @@ theme: toggle: icon: material/weather-night name: Switch to light mode - primary: orange - accent: orange + primary: indigo + accent: indigo features: - content.code.copy - navigation.tabs