playing with docs

reflectometry · Sep 10, 2024 · 906fe83 · 906fe83
1 parent ea47158
commit 906fe83
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -5,6 +5,11 @@ build:
   tools:
     python: "mambaforge-22.9"
 
+python:
+  install:
+    - method: pip
+      path: .
+
 sphinx:
   builder: html
   configuration: docs/conf.py

diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
+[![Documentation Status](https://readthedocs.org/projects/refl1d-models/badge/?version=latest)](https://refl1d-models.readthedocs.io/en/latest/?badge=latest)
+
+
 refl1d models
 =============
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
 =========================================
-Welcome to python project template docs!
+Refl1d example models
 =========================================
 
 .. toctree::