PHYTEC phyHUB Documentation

Getting the Source Code

Clone the Git repository:

git clone https://github.com/phytec/doc-phyhub.git

Change your current working directory to the just cloned source code:

cd doc-phyhub/

This documentation depends on Python tox for building. It is recommended to install it in a virtualenv with pip. All required dependencies are specified in requirements/:

python3 -m venv env
source env/bin/activate
pip3 install -r requirements/setup.txt

Building the Documentation

There following build targets are available:

• tox -e html: Build the documentation as HTML for the default language (en). This build command builds the documentation in multi-core mode and is the fastest. Building the documentation in other languages does not support parallel processing and is significantly slower.

  In addition the HTML build uses sphinx-autobuild to automatically rebuild the documentation when a source file changes. The documentation is afterwards hosted on a free port on your local machine. Exit with CTRL+C.

Open the locally built HTML pages in your webbrowser in the default language:

xdg-open build/html/index.html