mirror of
https://github.com/nicolargo/glances.git
synced 2024-11-23 20:45:33 +03:00
Update docs and Makefile
This commit is contained in:
parent
4ecbb61bb9
commit
ee3f43985e
22
Makefile
22
Makefile
@ -14,35 +14,35 @@ install: ## Open a Web Browser to the installation procedure
|
||||
venv-python: ## Install Python 3 venv
|
||||
virtualenv -p /usr/bin/python3 venv
|
||||
|
||||
venv-dev: ## Install Python 3 dev dependencies
|
||||
venv-dev: venv-python ## Install Python 3 dev dependencies
|
||||
./venv/bin/pip install -r dev-requirements.txt
|
||||
./venv/bin/pip install -r doc-requirements.txt
|
||||
|
||||
venv-dev-upgrade: ## Upgrade Python 3 dev dependencies
|
||||
venv-dev-upgrade: venv-dev ## Upgrade Python 3 dev dependencies
|
||||
./venv/bin/pip install --upgrade pip
|
||||
./venv/bin/pip install --upgrade -r dev-requirements.txt
|
||||
./venv/bin/pip install --upgrade -r doc-requirements.txt
|
||||
|
||||
venv: ## Install Python 3 run-time dependencies
|
||||
venv: venv-python ## Install Python 3 run-time dependencies
|
||||
./venv/bin/pip install -r requirements.txt
|
||||
./venv/bin/pip install -r optional-requirements.txt
|
||||
|
||||
venv-upgrade: ## Upgrade Python 3 run-time dependencies
|
||||
venv-upgrade: venv ## Upgrade Python 3 run-time dependencies
|
||||
./venv/bin/pip install --upgrade -r dev-requirements.txt
|
||||
./venv/bin/pip install --upgrade -r requirements.txt
|
||||
./venv/bin/pip install --upgrade -r optional-requirements.txt
|
||||
|
||||
test: venv ## Run unit tests
|
||||
test: venv-upgrade venv-dev-upgrade ## Run unit tests
|
||||
./venv/bin/python ./unitest.py
|
||||
./venv/bin/python ./unitest-restful.py
|
||||
./venv/bin/python ./unitest-xmlrpc.py
|
||||
./venv/bin/python -m black ./glances --check --exclude outputs/static
|
||||
./venv/bin/pyright glances
|
||||
|
||||
format: venv ## Format the code
|
||||
format: venv-dev-upgrade ## Format the code
|
||||
./venv/bin/python -m black ./glances --exclude outputs/static
|
||||
|
||||
docs: venv-dev ## Create the documentation
|
||||
docs: venv-dev-upgrade ## Create the documentation
|
||||
./venv/bin/python -m glances -C ./conf/glances.conf --api-doc > ./docs/api.rst
|
||||
cd docs && ./build.sh && cd ..
|
||||
|
||||
@ -50,10 +50,10 @@ docs-server: docs ## Start a Web server to serve the documentation
|
||||
(sleep 2 && sensible-browser "http://localhost:$(PORT)") &
|
||||
cd docs/_build/html/ && ../../../venv/bin/python -m http.server $(PORT)
|
||||
|
||||
webui: venv-dev ## Build the Web UI
|
||||
webui: venv-dev-upgrade ## Build the Web UI
|
||||
cd glances/outputs/static/ && npm ci && npm run build
|
||||
|
||||
webui-audit: venv-dev ## Audit the Web UI
|
||||
webui-audit: venv-dev-upgrade ## Audit the Web UI
|
||||
cd glances/outputs/static/ && npm audit
|
||||
|
||||
run: ## Start Glances in console mode (also called standalone)
|
||||
@ -98,10 +98,10 @@ release-note: ## Generate release note
|
||||
@echo "\n"
|
||||
git --no-pager shortlog -s -n $(LASTTAG)..HEAD
|
||||
|
||||
flatpak: venv-dev ## Generate FlatPack JSON file
|
||||
flatpak: venv-dev-upgrade ## Generate FlatPack JSON file
|
||||
git clone https://github.com/flatpak/flatpak-builder-tools.git
|
||||
./venv/bin/python ./flatpak-builder-tools/pip/flatpak-pip-generator glances
|
||||
mv python3-glances.json ../flathub/
|
||||
rm -rf ./flatpak-builder-tools
|
||||
@echo "Now follow: https://github.com/flathub/flathub/wiki/App-Submission"
|
||||
|
||||
.PHONY: test docs docs-server venv
|
||||
|
764
docs/api.rst
764
docs/api.rst
File diff suppressed because it is too large
Load Diff
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "GLANCES" "1" "Aug 08, 2022" "3.3.0_beta1" "Glances"
|
||||
.TH "GLANCES" "1" "Aug 20, 2022" "3.3.0_beta1" "Glances"
|
||||
.SH NAME
|
||||
glances \- An eye on your system
|
||||
.SH SYNOPSIS
|
||||
|
2
glances/outputs/static/public/glances.js
vendored
2
glances/outputs/static/public/glances.js
vendored
File diff suppressed because one or more lines are too long
2
glances/outputs/static/public/glances.map.js
vendored
2
glances/outputs/static/public/glances.map.js
vendored
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user