Switch to using mkdocs for docs

crisishistory · Oct 22, 2023 · 1516422 · 1516422
1 parent ee5d09c
commit 1516422
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 149 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -17,7 +17,7 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+   configuration: docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/README_link.md b/docs/README_link.md
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,5 @@
+{%
+   include-markdown "../README.md"
+   start="<!--intro-start-->"
+   end="<!--intro-end-->"
+%}
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+mkdocs-material
+mkdocs-include-markdown-plugin
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,26 @@
+site_name: HistoryAIToolKit
+repo_url: https://github.com/historysciencelab/HistoryAIToolkit
+theme:
+  name: material
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - search.suggest
+    - search.highlight
+    - search.share
+  icon:
+    repo: fontawesome/brands/github
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+
+plugins:
+  - search
+  - include-markdown    
+
+
+nav:
+  - Introduction: index.md
+  - "Getting Started": getting_started.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,10 +35,8 @@ dev = [
     "coverage==7.3.2",  # testing
     "isort",  # code auto-formatting
     "mypy",  # linting
-    "myst-parser",  # markdown parsing
     "pytest",  # testing
     "ruff==0.0.292",  # linting
-    "sphinx",  # documentation
     "pre-commit==3.4.0", # manages and maintains pre-commit hooks
 ]