mirror of https://github.com/nicolargo/glances.git
Update docs
This commit is contained in:
parent
38448dcbfb
commit
8086e1033c
4
Makefile
4
Makefile
|
|
@ -11,17 +11,19 @@ docs:
|
|||
|
||||
docs-server: docs
|
||||
(sleep 2 && sensible-browser "http://localhost:$(PORT)") &
|
||||
cd docs/_build/html/ && python -m SimpleHTTPServer $(PORT)
|
||||
cd docs/_build/html/ && ./venv/bin/python -m SimpleHTTPServer $(PORT)
|
||||
|
||||
webui:
|
||||
cd glances/outputs/static/ && npm install && npm audit fix && npm run build
|
||||
|
||||
venv:
|
||||
virtualenv -p /usr/bin/python3 venv
|
||||
./venv/bin/pip install -r ./docs/doc-requirements.txt
|
||||
./venv/bin/pip install -r requirements.txt
|
||||
./venv/bin/pip install -r optional-requirements.txt
|
||||
|
||||
venv-upgrade:
|
||||
./venv/bin/pip install --upgrade -r ./docs/doc-requirements.txt
|
||||
./venv/bin/pip install --upgrade -r requirements.txt
|
||||
./venv/bin/pip install --upgrade -r optional-requirements.txt
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXBUILD = ../venv/bin/sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
|
||||
|
|
|
|||
|
|
@ -3,11 +3,11 @@ Building the docs
|
|||
|
||||
First install Sphinx and the RTD theme:
|
||||
|
||||
pip install sphinx sphinx_rtd_theme
|
||||
make venv
|
||||
|
||||
or update it if already installed:
|
||||
|
||||
pip install --upgrade sphinx sphinx_rtd_theme
|
||||
make venv-upgrade
|
||||
|
||||
Go to the docs folder:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,2 @@
|
|||
sphinx
|
||||
sphinx_rtd_theme
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "GLANCES" "1" "May 23, 2021" "3.1.8b3" "Glances"
|
||||
.TH "GLANCES" "1" "May 26, 2021" "3.1.8b3" "Glances"
|
||||
.SH NAME
|
||||
glances \- An eye on your system
|
||||
.
|
||||
|
|
|
|||
Loading…
Reference in New Issue