As a prerequisite, a RAPIDS compatible GPU is required to build the docs since the notebooks in the docs execute the code to generate the HTML output.
In order to build the docs, we need the conda dev environment from cudf and build cudf from source. See build instructions.
-
Create a conda env and build cudf from source. The dependencies to build rapids from source are installed in that conda environment, and then rapids is built and installed into the same environment.
-
Once cudf is built from source, navigate to
../docs/cudf/. If you have your documentation written and want to turn it into HTML, run makefile:
#be in the same directory as your Makefile
make htmlThis should run Sphinx in your shell, and outputs to build/html/index.html.
First navigate to /build/html/ folder, i.e., cd build/html and then run the following command:
python -m http.serverThen, navigate a web browser to the IP address or hostname of the host machine at port 8000:
https://<host IP-Address>:8000
Now you can check if your docs edits formatted correctly, and read well.