chore: clean up (#10)

### Summary of Changes

* Remove some outdated linter configs
* Move linter config to `pyproject.toml` where possible
* Move `pyproject.toml` and `poetry.lock` to top-level to be able to
reuse `README.md` in `docs/`
* Specify dependencies to build documentation using `poetry`

.github/dependabot.yml

@@ -14,15 +14,7 @@ updates:
     directory: '/'
     schedule:
       interval: 'monthly'
-
-  # docs
-  - package-ecosystem: 'pip'
-    directory: '/docs'
-    schedule:
-      interval: 'monthly'
-
-  # src
   - package-ecosystem: 'pip'
-    directory: '/src'
+    directory: '/'
     schedule:
       interval: 'monthly'

.github/workflows/main.yml

@@ -11,6 +11,6 @@ jobs:
         python-version: [ "3.10" ]
     uses: lars-reimann/.github/.github/workflows/poetry-codecov-reusable.yml@main
     with:
-      working-directory: src
+      working-directory: .
       python-version: ${{ matrix.python-version }}
       module-name: safeds_examples

.github/workflows/merge_queue.yml

@@ -10,7 +10,7 @@ jobs:
         python-version: [ "3.10" ]
     uses: lars-reimann/.github/.github/workflows/poetry-codecov-reusable.yml@main
     with:
-      working-directory: src
+      working-directory: .
       python-version: ${{ matrix.python-version }}
       module-name: safeds_examples
       coverage: false

.github/workflows/pr.yml

@@ -15,6 +15,6 @@ jobs:
         python-version: [ "3.10" ]
     uses: lars-reimann/.github/.github/workflows/poetry-codecov-reusable.yml@main
     with:
-      working-directory: src
+      working-directory: .
       python-version: ${{ matrix.python-version }}
       module-name: safeds_examples

.github/workflows/release.yml

@@ -7,7 +7,7 @@ jobs:
   release:
     uses: lars-reimann/.github/.github/workflows/poetry-pypi-reusable.yml@main
     with:
-      working-directory: src
+      working-directory: .
       python-version: "3.10"
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

.gitignore

@@ -30,6 +30,10 @@ venv/
 .pytest_cache/
 htmlcov/
 .coverage
+coverage.xml
+
+# mkdocs
+/site/
 
 # MegaLinter
 report/

docs/README.md

@@ -3,8 +3,8 @@
 [![PyPI](https://img.shields.io/pypi/v/safe-ds-examples)](https://pypi.org/project/safe-ds-examples/)
 [![Main](https://github.com/Safe-DS/Stdlib-Examples/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Stdlib-Examples/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/Safe-DS/Stdlib-Examples/branch/main/graph/badge.svg?token=X5CU9V952H)](https://codecov.io/gh/Safe-DS/Stdlib-Examples)
-[![Documentation Status](https://readthedocs.org/projects/stdlib-examples/badge/?version=latest)](https://stdlib-examples.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/stdlib-examples/badge/?version=latest)](https://stdlib-examples.safe-ds.com)
 
 Ready-to-use examples for the [Safe-DS Python Library](https://github.com/Safe-DS/Stdlib).
 
-You can find the full documentation [here](https://stdlib-examples.readthedocs.io/).
+You can find the full documentation [here](https://stdlib-examples.safe-ds.com).

src/pyproject.toml → pyproject.toml

@@ -4,11 +4,12 @@ version = "0.1.0"
 description = "Ready-to-use examples for the Safe-DS Python library."
 license = "MIT"
 authors = ["Lars Reimann <[email protected]>"]
-readme = "README.md"
+readme = "docs/README.md"
 repository = "https://github.com/Safe-DS/Stdlib-Examples"
+documentation = "https://stdlib-examples.safe-ds.com"
 keywords = ["data science", "machine learning", "usability", "learnability"]
 packages = [
-    { include = "safeds_examples" },
+    { include = "safeds_examples", from = "src" },
 ]
 
 [tool.poetry.dependencies]
@@ -19,6 +20,23 @@ safe-ds = "^0.2.0"
 pytest = "^7.2.1"
 pytest-cov = "^4.0.0"
 
+[tool.poetry.group.docs.dependencies]
+jupyter = "^1.0.0"
+mkdocs = "^1.4.2"
+mkdocstrings = "^0.20.0"
+mkdocstrings-python = "^0.8.3"
+mkdocs-autorefs = "^0.4.1"
+mkdocs-gen-files = "^0.4.0"
+mkdocs-glightbox = "^0.3.1"
+mkdocs-literate-nav = "^0.6.0"
+mkdocs-material = "^9.1.2"
+mkdocs-section-index = "^0.3.5"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.mypy]
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+ignore_missing_imports = true

readthedocs.yml

@@ -4,12 +4,13 @@ build:
   os: ubuntu-22.04
   tools:
     python: '3.10'
+  jobs:
+    # https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+    post_install:
+      - poetry install --with docs
 
 mkdocs:
   configuration: mkdocs.yml
-
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: src

release.config.js

@@ -14,22 +14,21 @@ module.exports = {
                 verifyConditionsCmd: `if [ 403 != $(curl -X POST -F ':action=file_upload' -u __token__:$PYPI_TOKEN -s -o /dev/null -w '%{http_code}' ${PYPI_REPOSITORY}) ]; then (exit 0); else (echo 'Authentication error. Please check the PYPI_TOKEN environment variable.' && exit 1); fi`,
                 prepareCmd: 'poetry version ${nextRelease.version}',
                 publishCmd: 'poetry publish --build --username __token__ --password $PYPI_TOKEN --no-interaction -vvv',
-                execCwd: 'src',
             },
         ],
         [
             '@semantic-release/github',
             {
                 assets: [
-                    { path: 'src/dist/*.tar.gz', label: 'sdist' },
-                    { path: 'src/dist/*.whl', label: 'wheel' },
+                    { path: 'dist/*.tar.gz', label: 'sdist' },
+                    { path: 'dist/*.whl', label: 'wheel' },
                 ],
             },
         ],
         [
             '@semantic-release/git',
             {
-                assets: ['src/pyproject.toml', 'docs/CHANGELOG.md'],
+                assets: ['pyproject.toml', 'docs/CHANGELOG.md'],
             },
         ],
     ],