Closed fnrizzi closed 2 weeks ago
we need to fix the instructions for building MUQ that are built in the 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
make doc
once built, cd into the doxygen_output and open index.html it should looks like https://mituq.bitbucket.io/source/_site/latest/index.html
doxygen_output
we should keep any existing content that is still applicable
we should make a single installation page where we describe few sections.
one section where we put a a table with list of packages names and how to enable them via the MUQENABLEGROUP. The list of packages name can be found in https://github.com/NexGenAnalytics/MIT-MUQ/issues/80
one section where we show how to enable the default groups
one section for the support for MPI
one section for the conda package
when posting the PR, please also attached the zipped documentation so i can download and check it out
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:
where tpls is the path to tols installed via the script in https://github.com/NexGenAnalytics/MIT-MUQ-containers/blob/main/build_tpls.py
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.htmlwhat we should do for the new doc
we should keep any existing content that is still applicable
we should make a single installation page where we describe few sections.
one section where we put a a table with list of packages names and how to enable them via the MUQENABLEGROUP. The list of packages name can be found in https://github.com/NexGenAnalytics/MIT-MUQ/issues/80
one section where we show how to enable the default groups
one section for the support for MPI
one section for the conda package
preparing the PR
when posting the PR, please also attached the zipped documentation so i can download and check it out