Merge pull request #35 from invrs-io/designs

Reorganize and fix docs
invrs-io · Jul 16, 2024 · b972d83 · b972d83
2 parents 055f23f + 19cb22c
commit b972d83
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 15 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -30,7 +30,8 @@ jobs:
         run: |
             git clone https://github.com/invrs-io/gym
             mkdir docs/notebooks/gym
-            mv gym/docs/notebooks docs/notebooks/gym/
+            mv gym/docs/notebooks/challenges/* docs/notebooks/challenges/
+            mv gym/reference_designs/ . -r
             python docs/run_first.py
             jb build docs
 

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -11,20 +11,20 @@ parts:
     # These notebooks are copies of those in the invrs-gym repo. In the github
     # action, the gym repo is cloned and notebooks moved over.
     chapters:
-    - file: notebooks/gym/notebooks/bayer_sorter
-    - file: notebooks/gym/notebooks/ceviche_challenges
-    - file: notebooks/gym/notebooks/diffractive_splitter
-    - file: notebooks/gym/notebooks/meta_atom_library
-    - file: notebooks/gym/notebooks/metagrating
-    - file: notebooks/gym/notebooks/metalens
-    - file: notebooks/gym/notebooks/photon_extractor
+    - file: notebooks/challenges/bayer_sorter
+    - file: notebooks/challenges/ceviche_challenges
+    - file: notebooks/challenges/diffractive_splitter
+    - file: notebooks/challenges/meta_atom_library
+    - file: notebooks/challenges/metagrating
+    - file: notebooks/challenges/metalens
+    - file: notebooks/challenges/photon_extractor
 
   - caption: Leaderboards
     chapters:
-    - file: notebooks/bayer_sorter
-    - file: notebooks/ceviche_challenges
-    - file: notebooks/diffractive_splitter
-    - file: notebooks/meta_atom_library
-    - file: notebooks/metagrating
-    - file: notebooks/metalens
-    - file: notebooks/photon_extractor
+    - file: notebooks/leaderboards/bayer_sorter
+    - file: notebooks/leaderboards/ceviche_challenges
+    - file: notebooks/leaderboards/diffractive_splitter
+    - file: notebooks/leaderboards/meta_atom_library
+    - file: notebooks/leaderboards/metagrating
+    - file: notebooks/leaderboards/metalens
+    - file: notebooks/leaderboards/photon_extractor
diff --git a/docs/notebooks/bayer_sorter.ipynb → ...notebooks/leaderboards/bayer_sorter.ipynb b/docs/notebooks/bayer_sorter.ipynb → ...notebooks/leaderboards/bayer_sorter.ipynb
diff --git a/docs/notebooks/ceviche_challenges.ipynb → ...oks/leaderboards/ceviche_challenges.ipynb b/docs/notebooks/ceviche_challenges.ipynb → ...oks/leaderboards/ceviche_challenges.ipynb
diff --git a/docs/notebooks/diffractive_splitter.ipynb → ...s/leaderboards/diffractive_splitter.ipynb b/docs/notebooks/diffractive_splitter.ipynb → ...s/leaderboards/diffractive_splitter.ipynb
diff --git a/docs/notebooks/meta_atom_library.ipynb → ...ooks/leaderboards/meta_atom_library.ipynb b/docs/notebooks/meta_atom_library.ipynb → ...ooks/leaderboards/meta_atom_library.ipynb
diff --git a/docs/notebooks/metagrating.ipynb → .../notebooks/leaderboards/metagrating.ipynb b/docs/notebooks/metagrating.ipynb → .../notebooks/leaderboards/metagrating.ipynb
diff --git a/docs/notebooks/metalens.ipynb → docs/notebooks/leaderboards/metalens.ipynb b/docs/notebooks/metalens.ipynb → docs/notebooks/leaderboards/metalens.ipynb
diff --git a/docs/notebooks/photon_extractor.ipynb → ...books/leaderboards/photon_extractor.ipynb b/docs/notebooks/photon_extractor.ipynb → ...books/leaderboards/photon_extractor.ipynb