Merge pull request #247 from MilesCranmer/interactive-api

.github/workflows/docs.yml

@@ -27,7 +27,7 @@ jobs:
           python-version: 3.9
           cache: pip
       - name: "Install packages for docs building"
-        run: pip install mkdocs-material mkdocs-autorefs 'mkdocstrings[python]' docstring_parser
+        run: pip install -r docs/requirements.txt
       - name: "Install PySR"
         run: pip install -e .
       - name: "Build API docs"

docs/interactive-docs.md

@@ -0,0 +1,10 @@
+# Interactive Reference ⭐
+
+<!-- Display content from `astroautomata.com/pysr_interactive` -->
+
+The following docs are interactive, and, based on your selections,
+will create a snippet of Python code at the bottom which you can execute locally.
+Note that this is an incomplete list of options; for the full list,
+see the [API Reference](api.md).
+
+<embed src="https://astroautomata.com/pysr_interactive" width="100%" height="2000px" />

docs/requirements.txt

@@ -0,0 +1,4 @@
+mkdocs-material
+mkdocs-autorefs
+mkdocstrings[python]
+docstring_parser

mkdocs.yml

@@ -34,6 +34,7 @@ nav:
     - api.md
     - api-advanced.md
   - backend.md
+  - interactive-docs.md
 
 extra:
   homepage: https://astroautomata.com/PySR