8000 cudf/docs/cudf at main · dominicshanshan/cudf · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
 
 

cudf

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Building Documentation

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.

Steps to follow:

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

  1. 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.

  2. 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 html

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

View docs web page by opening HTML in browser:

First navigate to /build/html/ folder, i.e., cd build/html 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.

0