Skip to content

Commit

Permalink
docs: minor changes (#28)
Browse files Browse the repository at this point in the history
### Summary of Changes

* Move root `README` into `docs` folder
* Use external logo
* Use indigo for dark mode, too
  • Loading branch information
lars-reimann authored Mar 7, 2023
1 parent 9ad1667 commit 5afc40e
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 23 deletions.
12 changes: 0 additions & 12 deletions README.md

This file was deleted.

14 changes: 10 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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/
6 changes: 4 additions & 2 deletions docs/reference/generate_reference_pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]:
"""
Expand All @@ -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("")
Expand All @@ -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
Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 5afc40e

Please sign in to comment.