From 08712cb4009305479bbf898ad8ad19d2af6a0b98 Mon Sep 17 00:00:00 2001 From: Leonardo Schwarz Date: Fri, 9 Aug 2024 15:51:06 +0200 Subject: [PATCH] docs --- README.md | 2 ++ docs/contribute.md | 12 ++++++++++++ pyproject.toml | 3 ++- 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b704e2ee..8bfa4716 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ This package connects the [bfabric](https://fgcz-bfabric.uzh.ch/bfabric/) system The [bfabricShiny](https://github.com/cpanse/bfabricShiny) R package is an extension and provides code snippets and sample implementation for a seamless R shiny bfabric integration. For more advanced users the *bfabricPy* package also provides a powerful query interface on the command-line though using the provided scripts. +You can find the up-to-date documentation at [https://fgcz.github.io/bfabricPy](https://fgcz.github.io/bfabricPy). + ## CheatSheet ### Read diff --git a/docs/contribute.md b/docs/contribute.md index 48803fc1..f6929069 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -17,3 +17,15 @@ With `nox` and `uv` installed, it is as simple as running `nox` in the project r ## Integration tests Note that integration tests have been moved to a separate repository. Please contact us if you are interested. + +## Documentation + +We currently do not have a versioning solution for the documentation, but we can add that later once it is more mature. + +```bash +# To preview while you write it +mkdocs serve + +# To publish after changes +mkdocs gh-deploy +``` diff --git a/pyproject.toml b/pyproject.toml index 0d8b762b..015b6e1c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,7 +42,8 @@ dev = [ "pytest-mock", "logot", "nox", - "uv" + "uv", + "mkdocs" ] [project.urls]