#134 Add build guide to README
Merged 2 years ago by zlopez. Opened 2 years ago by zlopez.
fedora-infra/ zlopez/arc update_README  into  main

file added
+1
@@ -0,0 +1,1 @@ 

+ .venv/

file modified
+30
@@ -5,3 +5,33 @@ 

  

  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`

file modified
+1
@@ -1,2 +1,3 @@ 

  myst_parser

+ sphinx

  sphinx-rtd-theme

Pull-Request has been merged by zlopez

2 years ago