aai-institute / continuiti

Learning function operators with neural networks.

GNU Lesser General Public License v3.0

19 stars 3 forks source link

Cleanup: Docs requirements / Contributing #75

Closed samuelburbulla closed 6 months ago

samuelburbulla commented 6 months ago

Cleanup: Docs requirements / Contributing

Description

Which issue does this PR tackle?

Optional dependencies are split across pyproject.toml (testing) and docs/requirements.txt (docs).

How does it solve the problem?

Move dependencies for docs from docs/requirements.txt to pyproject.toml.
Update Contributing.
Adds contributing to documentation page.

How are the changes tested?

Locally.

Checklist for Contributors

[x] Scope: This PR tackles exactly one problem.
[x] Conventions: The branch follows the feature/title-slug convention.
[x] Conventions: The PR title follows the Bugfix: Title convention.
[x] Coding style: The code passes all pre-commit hooks.
[x] Documentation: All changes are well-documented.
[x] Tests: New features are tested and all tests pass successfully.
[x] Changelog: Updated CHANGELOG.md for new features or breaking changes.
[x] Review: A suitable reviewer has been assigned.

Checklist for Reviewers:

[x] The PR solves the issue it claims to solve and only this one.
[x] Changes are tested sufficiently and all tests pass.
[x] Documentation is complete and well-written.
[x] Changelog has been updated, if necessary.