nicolargo/glances
1
1
Fork 0
mirror of https://github.com/nicolargo/glances.git synced 2024-11-25 08:33:22 +03:00
Code Issues Projects Releases Wiki Activity

Workaround for the documentation version issue

Browse Source
This commit is contained in:
nicolargo 2016-03-12 10:15:44 +01:00
parent be16b9992b
commit 00cb350e42
3 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Makefile
View File

@ -2,7 +2,7 @@
# #
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = SPHINXOPTS = -D version=2.6 -D release=2.6_RC1
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
PAPER = PAPER =
BUILDDIR = _build BUILDDIR = _build
@ -156,6 +156,9 @@ man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo @echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." @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 .PHONY: texinfo
texinfo: texinfo:

23
docs/README.txt
View File

@ -5,15 +5,22 @@ First install Sphinx:
pip 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 make man
Then:
rm man/glances.1
cp _build/man/glances.1 man/glances.1

2
docs/man/glances.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" 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 .SH NAME
glances \- An eye on your system glances \- An eye on your system
. .