github-starred/nvitop
2
0
Fork 0
mirror of https://github.com/XuehaiPan/nvitop.git synced 2026-05-15 14:15:55 -06:00
Code Issues 29 Projects Packages Wiki Activity Actions
nvitop/docs
History
Exact
Xuehai Pan a8fe6924ad feat(tui): implement curses emulation with ANSI escape sequences 
- Add complete terminal handling with screen buffer management
- Implement keyboard and mouse input (SGR extended mouse protocol)
- Add support for text attributes, colors, and ACS line-drawing characters
- Handle wide characters and combining character merging
- Support both Windows (msvcrt) and Unix (termios) platforms
- Fix ERR constant to match standard curses (-1 instead of 1)
- Fix unctrl() return type annotation (str instead of int)
2026-02-02 01:06:20 +08:00
..
source feat(tui): implement curses emulation with ANSI escape sequences 2026-02-02 01:06:20 +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

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