Commit 6b49e687 authored by Francisco-Javier Ramon Salguero's avatar Francisco-Javier Ramon Salguero
Browse files

Updated build procedure

parent 665ce622
Loading
Loading
Loading
Loading
+4 −0
Original line number Diff line number Diff line
@@ -19,6 +19,8 @@ Install the required packages:
sudo -H python3 -m pip install -r requirements.txt
```

Before proceeding, **make sure that there are no uncommitted changes in your workdir or your staging area** (in case of doubt, do all the corresponding `add`'s and `commit`'s).

Then run:

```bash
@@ -28,6 +30,8 @@ make clean
for i in [0-1]*.md; do sed -i "s/\.md\#/\.html\#/g" $i; done
# Build html documentation
make html
# Restore the markdown files to their previous state
git reset --hard
```

The generated HTML output is stored in `_build/html`. You can go to that folder and publish the content locally with a Simple HTTP Server in Python.