We supposed that you clone the repository in your computer.
- Place into the root folder project
- Create a virtual enviroment:
python3 -m venv .venv- Activte the virtual enviroment:
source .venv/bin/activate- Iniatialize the subdmodules:
git submodule update --init
- Update the submodule:
git submodule update --remote
- Install all Python requeriments
pip install -r requirements.txt- Proceed to install the theme with the instructions from README_Theme.md
- If the theme was already created and installed just build the project into the root folder.
sphinx-build -M html ./docs/source/ ./docs/build/- And run the project with:
sphinx-autobuild ./docs/source/ ./docs/build/htmlAlternative run build_first_time.sh script into the root folder