NexGenAnalytics / MIT-MUQ

BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

update documentation specifically the building instructions #92

Closed fnrizzi closed 2 weeks ago

fnrizzi commented 1 month ago

we need to fix the instructions for building MUQ that are built in the documentation

building documentation

to build doc, you first need to configure MUQ as if you were to build it, some for example:

tpls=/Users/fnrizzi/Desktop/tpls

cmake -DCMAKE_C_COMPILER=$CC \
      -DCMAKE_CXX_COMPILER=$CXX \
      -S $PWD/MIT-MUQ \
      -B $PWD/build \
      -DCMAKE_INSTALL_PREFIX=$PWD/install \
      -C ${tpls}/tpls_cache.txt \
      -DMUQ_USE_GTEST=ON \
      -DMUQ_ENABLEGROUP_DEFAULT=ON \
      -DMUQ_USE_PYTHON=ON \
      -DCMAKE_VERBOSE_MAKEFILE=ON

where tpls is the path to tols installed via the script in https://github.com/NexGenAnalytics/MIT-MUQ-containers/blob/main/build_tpls.py

pip install Jinja2 setuptools

rendering the documentation

once built, cd into the doxygen_output and open index.html it should looks like https://mituq.bitbucket.io/source/_site/latest/index.html

what we should do for the new doc

preparing the PR

when posting the PR, please also attached the zipped documentation so i can download and check it out