nvitop/docs/README.md
Xuehai Pan d5f7ada23b docs: resolve sphinx warnings
Signed-off-by: Xuehai Pan <XuehaiPan@pku.edu.cn>
2022-07-02 16:54:06 +08:00

628 B

The nvitop's Documentation

This directory contains the documentation of nvitop, the one-stop solution for GPU process management.

Requirements

  • sphinx
  • sphinx-autoapi
  • sphinx-autobuild
  • sphinx-copybutton
  • sphinx-rtd-theme
  • make

Steps to build the documentation

cd docs  # navigate to this directory
python3 -m venv --upgrade-deps .venv
source .venv/bin/activate
pip3 install -r ../requirements.txt -r requirements.txt
sphinx-autobuild --watch ../nvitop --open-browser source build