diff --git a/README.md b/README.md index 93acdc6f..1ba6c64f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ReSolve is a library of GPU-resident linear solver. It contains iterative and direct linear solvers designed to run on NVIDIA and AMD GPUs, as well as on CPU devices. -ReadTheDocs Documentation lives here https://ornl.github.io/ReSolve/ +ReadTheDocs Documentation lives here https://resolve.readthedocs.io/en/develop/ ## Getting started diff --git a/docs/index.rst b/docs/index.rst index bf0e592e..ac2c21b7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -153,9 +153,31 @@ call the preset flag in the cmake build step. cmake -B build --preset cluster -Support +Developing Documentation Using Dev Container ------- + Prerequisites + +1. install Docker Desktop and launch the app +2. install the "Remote Development" extension in VSCode +3. open your local clone of resolve in VSCode + +Build Container + +The build info for this container is in `.devcontainer/`. There is a Dockerfile and json file associated with the configuration. + +1. if connected, disconnect from the PNNL VPN +2. launch the container build + * `cmd shift p` to open the command pallette in vscode + * click `> Dev Container: rebuild and reopen container` + * this will start building the container, taking about 40 minutes + * click on the pop up with `(show log)` to view the progress + +3. Open new terminal within VSCODe and run the renderDocs.sh (note this takes a minute) +4. Open the link that was served to you after step 3 + +Note - pushing/pulling from git is not supported in a devcontainer, and should be done independently. + For any questions or to report a bug please submit a `GitHub issue `__. diff --git a/renderDocs.sh b/renderDocs.sh index 8a0e4770..08475584 100755 --- a/renderDocs.sh +++ b/renderDocs.sh @@ -8,4 +8,4 @@ sphinx-build . ./sphinx/_build && doxygen ./doxygen/Doxyfile.in && # Host the docs locally with python python3 -m http.server --directory ./sphinx/_build -popd +popd \ No newline at end of file