github-starred/nvitop
2
0
Fork 0
mirror of https://github.com/XuehaiPan/nvitop.git synced 2026-05-16 14:16:00 -06:00
Code Issues 29 Projects Packages Wiki Activity Actions 2
nvitop/docs
History
Xuehai Pan 0938e6a00c
refactor(api): compact and rename top-level module (#54)
2023-01-04 17:04:42 +08:00
..
source refactor(api): compact and rename top-level module (#54) 2023-01-04 17:04:42 +08:00
make.bat docs: add Sphinx-based documents 2022-07-01 13:01:22 +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: resolve sphinx warnings 2022-07-02 16:54:06 +08:00

README.md

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