This folder contains the scripts necessary to build the repository documentation. You can view the documentation at https://nvidia-merlin.github.io/dataloader/main.

You build the documentation with the tox command and specify the docs environment. The following steps are one way of many to build the documentation before opening a merge request.

1. Create a virtual environment:

   python -m venv .venv

2. Activate the virtual environment:

   source .venv/bin/activate

3. Install tox in the virtual environment:

   python -m pip install --upgrade pip
   python -m pip install tox

4. Build the documentation with tox:

   tox -e docs

These steps run Sphinx in your shell and create HTML in the docs/build/html/ directory.

View the docs web page by opening the HTML in your browser. First, navigate to the build/html/ directory and then run the following command:

python -m http.server

Afterward, open a web browser and access https://localhost:8000.

Check that yours edits formatted correctly and read well.