Add build guide to README

Signed-off-by: Michal Konecny <mkonecny@redhat.com>
This commit is contained in:
Michal Konecny 2023-11-15 14:42:16 +01:00
parent 7ed886a252
commit 3831828764
3 changed files with 32 additions and 0 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
.venv/

View file

@ -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`

View file

@ -1,2 +1,3 @@
myst_parser
sphinx
sphinx-rtd-theme