MilesCranmer commited on
Commit
07da2ce
1 Parent(s): 82165dd

Add README to docs folder

Browse files
Files changed (1) hide show
  1. docs/README.md +8 -0
docs/README.md ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ # PySR Documentation
2
+
3
+ ## Building locally
4
+
5
+ 1. In the base directory, run `pip install -r docs/requirements.txt`.
6
+ 2. Install PySR in editable mode: `pip install -e .`.
7
+ 3. Build doc source with `cd docs && ./gen_docs.sh && cd ..`.
8
+ 4. Create and serve docs with mkdocs: `mkdocs serve -w pysr`.