diff options
| author | nicolargo <nicolashennion@gmail.com> | 2016-03-12 10:15:44 +0100 |
|---|---|---|
| committer | nicolargo <nicolashennion@gmail.com> | 2016-03-12 10:15:44 +0100 |
| commit | 00cb350e42579d81984e0c919d4febfd5ae90a7d (patch) | |
| tree | 0cb411929bd1f3a142375e2b0a2e66ff2e0f039e /docs/README.txt | |
| parent | be16b9992b79b11f56fff4019879cfef5bbeec24 (diff) | |
Workaround for the documentation version issue
Diffstat (limited to 'docs/README.txt')
| -rw-r--r-- | docs/README.txt | 21 |
1 files changed, 14 insertions, 7 deletions
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: - make man + cd docs + +Edit the Makefile (line 5): + + SPHINXOPTS = -D version=2.6 -D release=2.6_RC1 -Then: +Then build the HTML documentation: - rm man/glances.1 - cp _build/man/glances.1 man/glances.1 + make html + +and the man page: + + make man |