docs: ✨ 📝 Add index page

qthequartermasterman · May 10, 2024 · 510e3df · 510e3df
1 parent 95ffac5
commit 510e3df
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,6 @@
+# Welcome to `hypothesis-torch`
+
+Hypothesis strategies for various Pytorch structures (including tensors and modules).
+
+[Hypothesis](https://hypothesis.readthedocs.io/en/latest/) is a powerful property-based testing library for Python. It
+lacks built-in support for Pytorch tensors and modules, so this library provides strategies for generating them.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,6 +6,7 @@ repo_url: https://github.com/qthequartermasterman/hypothesis-torch
 edit_uri: edit/main/docs/
 
 nav:
+  - index.md
   - quick_start_guide.md
   - strategies.md
   - compatability.md