Installing mkdocs material broke the symlink between the readme and t…

…he docs index. After trying several other plugins which didn't work I switched to using symbolic linking. This doensn't work on Windows, but I added a note in the readme for Windows folks. This seems to be the recommended solution by the mkdocs folks: mkdocs/mkdocs#1250.
ChiSym · Nov 20, 2024 · 1431e10 · 1431e10
1 parent c843efa
commit 1431e10
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,9 @@ GenParse is a Python library for constrained generation with language models, sp
 
 > **⚠️ Warning:** This library is currently in active development. We recommend frequently pulling the latest version to stay updated with improvements and bug fixes. Please report any bugs in [the issue tracker](https://github.com/probcomp/genparse/issues).
 
-First time here? Go to our [Full Documentation](https://genparse.gen.dev/).
+First time here? Go to our [Full Documentation](https://genparse.gen.dev/). 
+
+> **💡Tip**: Note that the documentation index is symlinked from the README.md file. If you are on a Windows machine you will need to symlink the README.md file to docs/index.md before building the docs.
 
 ## Installation
 
@@ -81,7 +83,8 @@ Genparse currently supports the following HuggingFace language models. If you wo
 | gpt2-medium       | gpt2-medium                          |
 | gpt2-large        | gpt2-large                           |
 
-> **💡Tip**: Adding a `mock-` prefix to a language model name will create an imitation language model over the same vocabulary that can be used for testing (e.g., `mock-gpt2`). In practice, these models can be useful for rapid prototyping with minimal hardware.
+
+Adding a `mock-` prefix to a language model name will create an imitation language model over the same vocabulary that can be used for testing (e.g., `mock-gpt2`). In practice, these models can be useful for rapid prototyping with minimal hardware.
 
 
 ## Development

diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+../README.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,5 +7,5 @@ nav:
   - Troubleshooting: troubleshooting.md
 theme:
   name: material
-plugins:
-  - include-markdown
+  palette:
+    scheme: slate
diff --git a/setup.py b/setup.py
@@ -23,7 +23,6 @@
     'maturin',  # for rust parser
     'psutil',
     'mkdocs',
-    'mkdocs-include-markdown-plugin',
     'mkdocs-material',
 ]