nvitop/docs
Xuehai Pan 251f071c2c
Some checks failed
Build / build (release) Has been cancelled
Build / publish (release) Has been cancelled
ver: bump version to v1.5.3
2025-08-16 14:14:34 +08:00
..
source ver: bump version to v1.5.3 2025-08-16 14:14:34 +08:00
make.bat chore: add .editorconfig 2023-01-21 02:16:16 +08:00
Makefile docs: add Sphinx-based documents 2022-07-01 13:01:22 +08:00
README.md docs: resolve sphinx warnings 2022-07-02 16:54:06 +08:00
requirements.txt docs: remove callbacks from online docs 2025-05-13 14:31:02 +08:00

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