From 00cb350e42579d81984e0c919d4febfd5ae90a7d Mon Sep 17 00:00:00 2001 From: nicolargo Date: Sat, 12 Mar 2016 10:15:44 +0100 Subject: [PATCH] Workaround for the documentation version issue --- docs/Makefile | 5 ++++- docs/README.txt | 23 +++++++++++++++-------- docs/man/glances.1 | 2 +- 3 files changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 58b05917..f3825434 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -D version=2.6 -D release=2.6_RC1 SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build @@ -156,6 +156,9 @@ man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + rm -f man/* + cp $(BUILDDIR)/man/* man/ + @echo "The manual page have been copied in ./man." .PHONY: texinfo texinfo: diff --git a/docs/README.txt b/docs/README.txt index 38f26fb7..045dfce2 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -5,15 +5,22 @@ First install Sphinx: pip install sphinx -Then build: +or update it if already installed: - cd docs && make html + pip install --upgrade shpinx -To build the man page: +Go to the docs folder: + + cd docs + +Edit the Makefile (line 5): + + SPHINXOPTS = -D version=2.6 -D release=2.6_RC1 + +Then build the HTML documentation: + + make html + +and the man page: make man - -Then: - - rm man/glances.1 - cp _build/man/glances.1 man/glances.1 diff --git a/docs/man/glances.1 b/docs/man/glances.1 index 7ddcf68f..0bd3228b 100644 --- a/docs/man/glances.1 +++ b/docs/man/glances.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "GLANCES" "1" "mars 11, 2016" "2.5.1" "Glances" +.TH "GLANCES" "1" "mars 12, 2016" "2.6" "Glances" .SH NAME glances \- An eye on your system .