added docs badge to README and link to pyproject

apax-hub · Nov 13, 2023 · a4cd3e7 · a4cd3e7
1 parent 17c7431
commit a4cd3e7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # `apax`: Atomstic learned Potentials in JAX!
+[![Read the Docs](https://readthedocs.org/projects/apax/badge/)](https://apax.readthedocs.io/en/latest/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -7,6 +7,7 @@ keywords=["machine-learning", "interatomic potentials", "molecular-dynamics"]
 license = "MIT"
 readme = "README.md"
 packages = [{include = "apax"}]
+documentation = "https://apax.readthedocs.io/en/latest/"
 
 [tool.poetry.dependencies]
 python = ">=3.10,<3.12"
@@ -40,8 +41,6 @@ pre-commit = "^2.20.0"
 isort = "^5.10.1"
 flake8 = "^5.0.4"
 
-
-
 [tool.poetry.group.docs.dependencies]
 sphinx = "^7.2.6"
 sphinx-rtd-theme = "^1.3.0"