nvitop/docs
dependabot[bot] 8218bbd48b
deps(workflows): bump actions/checkout from 4 to 6 (#194)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Xuehai Pan <XuehaiPan@pku.edu.cn>
2025-11-25 00:30:12 +08:00
..
source deps(workflows): bump actions/checkout from 4 to 6 (#194) 2025-11-25 00:30:12 +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