From 29793a75f93f17c16e61102a3937b5b52e0b513c Mon Sep 17 00:00:00 2001 From: Kristoffer Andersson Date: Tue, 27 Sep 2022 15:25:02 +0200 Subject: [PATCH 1/2] docs: add mkdocs --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index c628d92f..0eede211 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -99,7 +99,7 @@ pylint = "^2.15.2" black = "^22.8.0" elasticsearch-test-py = "^1.1.0" requests = "^2.28.1" - +mkdocs = "^1.3.1" [tool.vulture] exclude = ["karp/tests/"] From 690cb84a36d0551723f31544530673a7b71f936d Mon Sep 17 00:00:00 2001 From: Kristoffer Andersson Date: Wed, 5 Oct 2022 13:42:32 +0200 Subject: [PATCH 2/2] doc: add mkdocs stub --- docs/karp-backend-v6/docs/index.md | 1 + docs/karp-backend-v6/docs/reference.md | 0 docs/karp-backend-v6/docs/release-notes.md | 1 + docs/karp-backend-v6/mkdocs.yml | 16 ++++++++++++++++ pyproject.toml | 3 +++ 5 files changed, 21 insertions(+) create mode 100644 docs/karp-backend-v6/docs/index.md create mode 100644 docs/karp-backend-v6/docs/reference.md create mode 100644 docs/karp-backend-v6/docs/release-notes.md create mode 100644 docs/karp-backend-v6/mkdocs.yml diff --git a/docs/karp-backend-v6/docs/index.md b/docs/karp-backend-v6/docs/index.md new file mode 100644 index 00000000..0d5e723b --- /dev/null +++ b/docs/karp-backend-v6/docs/index.md @@ -0,0 +1 @@ +--8<-- "../../README.md" diff --git a/docs/karp-backend-v6/docs/reference.md b/docs/karp-backend-v6/docs/reference.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/karp-backend-v6/docs/release-notes.md b/docs/karp-backend-v6/docs/release-notes.md new file mode 100644 index 00000000..d5aaba19 --- /dev/null +++ b/docs/karp-backend-v6/docs/release-notes.md @@ -0,0 +1 @@ +--8<-- "../../CHANGELOG.md" diff --git a/docs/karp-backend-v6/mkdocs.yml b/docs/karp-backend-v6/mkdocs.yml new file mode 100644 index 00000000..fe81226b --- /dev/null +++ b/docs/karp-backend-v6/mkdocs.yml @@ -0,0 +1,16 @@ +site_name: Karp Backend +theme: material +nav: + - Home: index.md + - Reference: reference.md + - About: + - "Release Notes": release-notes.md + +repo_name: spraakbanken/karp-backend +repo_url: https://github.com/spraakbanken/karp-backend + +plugins: + - search + +markdown_extensions: + - pymdownx.snippets diff --git a/pyproject.toml b/pyproject.toml index 0eede211..3ff4aa47 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -100,6 +100,9 @@ black = "^22.8.0" elasticsearch-test-py = "^1.1.0" requests = "^2.28.1" mkdocs = "^1.3.1" +mkdocs-material = "^8.5.6" +mkdocstrings = "^0.19.0" +mkdocstrings-python = "^0.7.1" [tool.vulture] exclude = ["karp/tests/"]