Add README to docs folder

MilesCranmer · Jan 14, 2023 · 07da2ce · 07da2ce
1 parent 82165dd
commit 07da2ce
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,8 @@
+# PySR Documentation
+
+## Building locally
+
+1. In the base directory, run `pip install -r docs/requirements.txt`.
+2. Install PySR in editable mode: `pip install -e .`.
+3. Build doc source with `cd docs && ./gen_docs.sh && cd ..`.
+4. Create and serve docs with mkdocs: `mkdocs serve -w pysr`.