File: README.md

package info (click to toggle)
nvitop 1.5.2-1
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid
  • size: 1,452 kB
  • sloc: python: 12,688; sh: 407; makefile: 11
file content (22 lines) | stat: -rw-r--r-- 628 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# The `nvitop`'s Documentation

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

### Requirements  <!-- markdownlint-disable heading-increment -->

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

### Steps to build the documentation  <!-- markdownlint-disable heading-increment -->

```bash
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
```