Updated docs to move basic docs into readthedocs.

mmcdermott · Aug 8, 2024 · 1dedfad · 1dedfad
1 parent 8075963
commit 1dedfad
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 5 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1 @@
-# Welcome!
-
-MEDS-Transforms is a library. More details incoming.
+--8\<-- "README.md"
diff --git a/pipeline_configuration.md → docs/pipeline_configuration.md b/pipeline_configuration.md → docs/pipeline_configuration.md
diff --git a/preprocessing_operation_prototypes.md → docs/preprocessing_operation_prototypes.md b/preprocessing_operation_prototypes.md → docs/preprocessing_operation_prototypes.md
diff --git a/terminology.md → docs/terminology.md b/terminology.md → docs/terminology.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,6 +5,9 @@ site_author: Matthew McDermott
 
 nav:
   - Home: index.md
+  - "Pipeline Configuration": pipeline_configuration.md
+  - "Pre-processing Operations": preprocessing_operation_prototypes.md
+  - "Terminology": terminology.md
   - API: api/
   - Issues: https://github.com/mmcdermott/MEDS_transforms/issues
 
@@ -14,8 +17,16 @@ theme:
 
 markdown_extensions:
   - smarty
-    #  - pymdownx.arithmatex:
-    #      generic: true
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.smartsymbols
+  - pymdownx.snippets
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.superfences
 
 extra_javascript:
   - javascripts/mathjax.js