From 8086e1033c909e4eb618836f4746ca6555f8b780 Mon Sep 17 00:00:00 2001 From: Nicolas Hennion Date: Wed, 26 May 2021 15:51:43 +0200 Subject: [PATCH] Update docs --- Makefile | 4 +++- docs/Makefile | 2 +- docs/README.txt | 4 ++-- docs/doc-requirements.txt | 2 ++ docs/man/glances.1 | 2 +- 5 files changed, 9 insertions(+), 5 deletions(-) create mode 100644 docs/doc-requirements.txt diff --git a/Makefile b/Makefile index 4b73bdc8..1e274ece 100644 --- a/Makefile +++ b/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 diff --git a/docs/Makefile b/docs/Makefile index 30485295..75bae57f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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 diff --git a/docs/README.txt b/docs/README.txt index 4089ba4f..3f7b6b24 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -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: diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt new file mode 100644 index 00000000..856b3f4c --- /dev/null +++ b/docs/doc-requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_rtd_theme \ No newline at end of file diff --git a/docs/man/glances.1 b/docs/man/glances.1 index eb73ad55..81e33c31 100644 --- a/docs/man/glances.1 +++ b/docs/man/glances.1 @@ -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 .