Skip to content

Commit

Permalink
Update docs support info in README (#94)
Browse files Browse the repository at this point in the history
Describe process for building docs with tox.
  • Loading branch information
mikemckiernan authored Jan 20, 2023
1 parent ed51e4f commit 7b10d37
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,39 @@

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

## Contributing to Docs

Perform the following steps to build the docs.
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. Install the documentation dependencies:
1. Create a virtual environment:

```shell
python -m pip install -r docs/requirements-doc.txt
python -m venv .venv
```

1. Run the build command:
1. Activate the virtual environment:

```shell
make -C docs clean html
source .venv/bin/activate
```

Remove the `-C docs` argument if you are already in the `docs/` directory.
1. Install tox in the virtual environment:

These steps should run Sphinx in your shell and create HTML in the `build/html/`
```shell
python -m pip install --upgrade pip
python -m pip install tox
```

1. Build the documentation with tox:

```shell
tox -e docs
```

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

## Preview the Changes
Expand Down

0 comments on commit 7b10d37

Please sign in to comment.