Skip to content

Building Documentation Locally

Jump to bottom
Jonathan Lifflander edited this page Jun 22, 2021 · 3 revisions

To build the documentation locally, it is best to do it inside a container. However, there are several steps to ensure it viewable outside the container (i.e., the HTML).

  1. Make sure docker is installed properly along with docker-compose (on some platforms docker-compose needs to be installed separately)
  2. Clone vt, then cd vt.
  3. Configure the build through variables: export VT_DOCS=1; export COMPILER_TYPE=gnu; export COMPILER=gcc-8
  4. Set the cache directory so that generated docs are available on host machine: export CACHE=/tmp/docs
  5. docker-compose pull ubuntu-docs-interactive
  6. docker-compose run ubuntu-docs-interactive
  7. Once the container builds and it is running:
    1. /vt/ci/build_cpp.sh /vt /build
    2. After cmake configures, hit control-c
    3. git clone https://github.com/mosra/m.css; pushd m.css; git checkout 6eefd92c2aa3e0a257503d31b1a469867dfff8b6; popd
    4. cd /build/vt
    5. /m.css/documentation/doxygen.py Doxyfile-mcss
    6. Wait until all the documentation is generated
  8. Back on host: open /tmp/docs/amd64-ubuntu-18.04-gcc-8-cache/vt/docs/html/index.html
Clone this wiki locally