From 6e1e2f62e8cc92b76429d2412b171c5bd442b23e Mon Sep 17 00:00:00 2001 From: Nir <88795475+nrbnlulu@users.noreply.github.com> Date: Mon, 29 May 2023 10:14:39 +0300 Subject: [PATCH] update contributing.md --- docs/contributing.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/contributing.md b/docs/contributing.md index faaafa28..c5f47593 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -135,6 +135,20 @@ other people can use it as well. This section collects some technical information that you will need for updating Catch2's documentation, and possibly some generic advise as well. +We use mkdocs for documentation and poetry for python environment. +first install poetry (you'll need python...) +```console +pip install poetry +``` +Poetry will install our docs dependencies +```console +poetry install +``` +serve the docs locally to see your changes +```console +poetry run mkdocs serve +``` + ### Technicalities