cleanup

FAIRmat-NFDI · Jun 7, 2024 · c5b57ca · c5b57ca
1 parent c39f269
commit c5b57ca
Show file tree

Hide file tree

Showing 11 changed files with 3 additions and 164 deletions.
diff --git a/.cruft.json b/.cruft.json
diff --git a/.github/workflows/cruft-update.yml b/.github/workflows/cruft-update.yml
diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/README.md b/README.md
@@ -70,24 +70,18 @@ on the [PyPI documentation](https://packaging.python.org/en/latest/tutorials/pac
 
 ### Documentation on Github pages
 
-To deploy documentation on Github pages, make sure to [enable GitHub pages via the repo settings](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch). 
+To deploy documentation on Github pages, make sure to [enable GitHub pages via the repo settings](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch).
 
 To view the documentation locally, install the documentation related packages using:
 
 ```sh
-pip install -r requirements_docs.txt
+pip install -e '.[docs]'
 ```
 
 Run the documentation server:
 ```sh
 mkdocs serve
 ```
 
-### Template update
-
-We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests. 
-
-To run the check for updates locally, follow the instructions on [`cruft` website](https://cruft.github.io/cruft/#updating-a-project).
-
 ### License
 Distributed under the terms of the `Apache Software License 2.0`_ license, "nomad-aitoolkit" is free and open source software
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,6 +32,7 @@ Repository = "https://github.com/FAIRmat-NFDI/nomad-aitoolkit"
 
 [project.optional-dependencies]
 dev = ["ruff", "pytest", "structlog"]
+docs = ["mkdocs", "mkdocs-material==8.1.1", "pymdown-extensions", "mkdocs-click"]
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.

diff --git a/requirements_docs.txt b/requirements_docs.txt
diff --git a/tests/apps/test_app.py b/tests/apps/test_app.py
diff --git a/tests/data/.gitkeep b/tests/data/.gitkeep
diff --git a/tests/data/test.archive.yaml b/tests/data/test.archive.yaml
diff --git a/tests/normalizers/test_normalizer.py b/tests/normalizers/test_normalizer.py
diff --git a/tests/schema_packages/test_schema.py b/tests/schema_packages/test_schema.py