andre@933: TrustBridge documentation
andre@933: =========================
andre@933: 
andre@933: The TrustBridge documentation should be build automatically by the
andre@933: default target in cmake if sphinx is found.
andre@933: 
andre@936: Requirements on ubuntu 14.4:
andre@936: python-sphinx
andre@936: 
andre@933: How to build TrustBridge documentation manually
andre@933: ===============================================
emanuel@903: 
emanuel@903: The TrustBridge documentation based on Sphinx <http://sphinx-doc.org/>.
emanuel@903: Please install the requirements before you build the documentation.
emanuel@903: 
emanuel@903:   $ virtualenv .venv
emanuel@903:   $ . .venv/bin/activate
emanuel@903:   (.venv) pip install -r requirements.txt
emanuel@903: 
emanuel@903: 
emanuel@903: Build TrustBridge help pages:
emanuel@903:   (.venv) cd help-manual
emanuel@903:   (.venv) make html
emanuel@903: 
emanuel@903:   => Open HTML output: _build/html/index.html
emanuel@903: 
emanuel@903: 
emanuel@903: Build TrustBridge Admin help pages:
emanuel@903:   (.venv) cd admin-manual
emanuel@903:   (.venv) make html
emanuel@903: 
emanuel@903:   => Open HTML output: _build/html/index.html
emanuel@903: