From 0c9b5ef564e50e6ebdb327d3782134829e611dfa Mon Sep 17 00:00:00 2001 From: Daniel Perrefort Date: Thu, 19 Oct 2023 12:45:08 -0400 Subject: [PATCH] Adds mkdocs template --- docs/index.md | 3 +++ docs/installation.md | 1 + docs/usage.md | 1 + mkdocs.yml | 16 ++++++++++++++++ pyproject.toml | 7 +++++++ 5 files changed, 28 insertions(+) create mode 100644 docs/index.md create mode 100644 docs/installation.md create mode 100644 docs/usage.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..908618f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# CRC-Shinigami + +::: shinigami diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..739ee74 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1 @@ +# Installation and Setup diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..d15175b --- /dev/null +++ b/docs/usage.md @@ -0,0 +1 @@ +# Usage Examples diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..615c0c1 --- /dev/null +++ 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 © University of Pittsburgh. All rights reserved. diff --git a/pyproject.toml b/pyproject.toml index 41460fd..b2e03c4 100644 --- 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 = "*"}