From 38318287643274642eac799ed63f5b89781a9111 Mon Sep 17 00:00:00 2001 From: Michal Konecny Date: Wed, 15 Nov 2023 14:42:16 +0100 Subject: [PATCH] Add build guide to README Signed-off-by: Michal Konecny --- .gitignore | 1 + README.md | 30 ++++++++++++++++++++++++++++++ docs/requirements.txt | 1 + 3 files changed, 32 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..21d0b89 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.venv/ diff --git a/README.md b/README.md index 12a2632..8a35c6c 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,33 @@ the investigation that the ARC team leads. More documentation about the team can be found at: https://fedora-arc.readthedocs.io/en/latest/index.html + + +## How to build locally + +1. Create python virtual environment + + ``` + python3 -m venv .venv + ``` + +2. Activate virtual environment + + ``` + . .venv/bin/activate + ``` + +3. Install requirements + + ``` + pip install -r docs/requirements.txt + ``` + +4. Execute the Makefile + + ``` + cd docs + make html + ``` + +5. You will find the compiled HTML in `docs/_build/html` diff --git a/docs/requirements.txt b/docs/requirements.txt index 6a14554..ddd2c76 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ myst_parser +sphinx sphinx-rtd-theme