Adds mkdocs template

pitt-crc · Oct 19, 2023 · 0c9b5ef · 0c9b5ef
1 parent f05ba7b
commit 0c9b5ef
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+# CRC-Shinigami
+
+::: shinigami
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1 @@
+# Installation and Setup
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1 @@
+# Usage Examples
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,16 @@
+site_name: CRC Shinigami
+repo_url: https://github.com/pitt-crc/shinigami
+theme:
+  name: readthedocs
+  highlightjs: true
+  include_homepage_in_sidebar: true
+  prev_next_buttons_location: bottom
+plugins:
+  - search:
+  - mkdocstrings:
+      custom_templates: templates
+nav:
+  - index.md
+  - installation.md
+  - usage.md
+copyright: Copyright &copy; University of Pittsburgh. All rights reserved.
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,3 +39,10 @@ optional = true
 
 [tool.poetry.group.tests.dependencies]
 coverage = "*"
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.5.3"
+mkdocstrings = {extras = ["python"], version = "*"}