All prerequisite for building docs are in the WholeGraph development conda environment. See build instructions on how to create the development conda environment

In order to build the docs, we need the conda dev environment and we need to build wholegraph from source.

1. Create a conda env and build wholegraph from source. The dependencies to build from source are installed in that conda environment, and then wholegraph is built and installed into the same environment.

2. Once wholegraph is built from source, navigate to ../docs/wholegraph/. If you have your documentation written and want to turn it into HTML, run makefile:

# most be in the /docs/wholegraph directory
make html

This should run Sphinx in your shell, and outputs to build/html/index.html

First navigate to /build/html/ folder, and then run the following command:

python -m http.server

Then, 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.