@@ -55,12 +55,11 @@ export PYTHONPATH=${CUDAQ_INSTALL_PREFIX}:${CUDAQX_INSTALL_PREFIX}
5555export PATH=" ${CUDAQ_INSTALL_PREFIX} /bin:${CUDAQX_INSTALL_PREFIX} /bin:${PATH} "
5656ctest
5757# Run the python tests
58- # The --ignore option is to bypass tests that require additional packages not contained in
58+ # The --ignore option is to bypass tests that require additional packages not contained in
5959# the standard docker container
6060cd ..
6161python3 -m pytest -v libs/qec/python/tests --ignore libs/qec/python/tests/test_tensor_network_decoder.py
6262python3 -m pytest -v libs/solvers/python/tests --ignore libs/solvers/python/tests/test_gqe.py
63-
6463```
6564
6665If you want to change which version of CUDA-Q that CUDA-QX is paired with, you
@@ -81,3 +80,14 @@ contributing to CUDA-QX, but it should be noted that while this environment
8180will have many GPU-accelerated simulators installed in it, it won't contain the
8281* highest* performing CUDA-Q simulators. See [ this note] ( https://nvidia.github.io/cuda-quantum/latest/using/install/data_center_install.html )
8382for more details.
83+
84+ ## Building CUDA-QX Documentation from Source
85+
86+ If you want to build and render our documentation from source, you can do this
87+ with the same environment as above. In particular, after running ` ninja install ` ,
88+ you can run ` ninja docs ` . This places the documentation into the
89+ ` /workspaces/cudaqx/build/docs/build/ ` directory. From there, you can open
90+ the ` index.html ` file in your browser, or if you are using VSCode or Cursor, you
91+ can simply browse to the ` index.html ` file in the Explorer panel, right click on
92+ the file, and select "Open with Live Server", and that will open your browser
93+ with the main docs page loaded automatically.
0 commit comments