Use Sphinx for doc

74 files changed, 1867 insertions, 2443 deletions

diff --git a/MANIFEST.in b/MANIFEST.in
index 1a6076a1..b299349b 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -15,5 +15,5 @@ include glances/outputs/static/js/vendors/*.js
 include glances/outputs/static/js/vendors/*.js.map
 include glances/outputs/static/images/*.png
 include man/glances.1
-recursive-include docs images/*.png glances-doc.html
+recursive-include docs *
 recursive-include glances *.py
diff --git a/README.rst b/README.rst
index 1cc785ad..26629153 100644
--- a/README.rst
+++ b/README.rst
@@ -266,7 +266,7 @@ and RTFM, always.
 Documentation
 =============
 
-For complete documentation see `glances-doc`_.
+For complete documentation have a look at the readthedocs_ website.
 
 If you have any question (after RTFM!), please post it on the official Q&A `forum`_.
 
@@ -301,6 +301,6 @@ LGPL. See ``COPYING`` for more details.
 .. _@nicolargo: https://twitter.com/nicolargo
 .. _@glances_system: https://twitter.com/glances_system
 .. _Python: https://www.python.org/getit/
-.. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst
+.. _readthedocs: https://glances.readthedocs.org/
 .. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users
 .. _wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F
diff --git a/docs/Makefile b/docs/Makefile
index 1ebbaed7..58b05917 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -7,6 +7,11 @@ SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
 
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
@@ -14,8 +19,7 @@ ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
+.PHONY: help
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html       to make standalone HTML files"
@@ -25,53 +29,66 @@ help:
 	@echo "  json       to make JSON files"
 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
 	@echo "  devhelp    to make HTML files and a Devhelp project"
 	@echo "  epub       to make an epub"
 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
 	@echo "  text       to make text files"
 	@echo "  man        to make manual pages"
 	@echo "  texinfo    to make Texinfo files"
 	@echo "  info       to make Texinfo files and run them through makeinfo"
 	@echo "  gettext    to make PO message catalogs"
 	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
 	@echo "  linkcheck  to check all external links for integrity"
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
 
+.PHONY: clean
 clean:
-	-rm -rf $(BUILDDIR)/*
+	rm -rf $(BUILDDIR)/*
 
+.PHONY: html
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+.PHONY: dirhtml
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
+.PHONY: singlehtml
 singlehtml:
 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
+.PHONY: pickle
 pickle:
 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 	@echo
 	@echo "Build finished; now you can process the pickle files."
 
+.PHONY: json
 json:
 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 	@echo
 	@echo "Build finished; now you can process the JSON files."
 
+.PHONY: htmlhelp
 htmlhelp:
 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 
+.PHONY: qthelp
 qthelp:
 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 	@echo
@@ -81,6 +98,16 @@ qthelp:
 	@echo "To view the help file:"
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Glances.qhc"
 
+.PHONY: applehelp
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+.PHONY: devhelp
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
@@ -90,11 +117,13 @@ devhelp:
 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Glances"
 	@echo "# devhelp"
 
+.PHONY: epub
 epub:
 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 	@echo
 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
+.PHONY: latex
 latex:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 	@echo
@@ -102,22 +131,33 @@ latex:
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 	      "(use \`make latexpdf' here to do that automatically)."
 
+.PHONY: latexpdf
 latexpdf:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 	@echo "Running LaTeX files through pdflatex..."
 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
+.PHONY: latexpdfja
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
 text:
 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 	@echo
 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
 
+.PHONY: man
 man:
 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 	@echo
 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
+.PHONY: texinfo
 texinfo:
 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 	@echo
@@ -125,29 +165,52 @@ texinfo:
 	@echo "Run \`make' in that directory to run these through makeinfo" \
 	      "(use \`make info' here to do that automatically)."
 
+.PHONY: info
 info:
 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 	@echo "Running Texinfo files through makeinfo..."
 	make -C $(BUILDDIR)/texinfo info
 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 
+.PHONY: gettext
 gettext:
 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 	@echo
 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 
+.PHONY: changes
 changes:
 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 	@echo
 	@echo "The overview file is in $(BUILDDIR)/changes."
 
+.PHONY: linkcheck
 linkcheck:
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 	      "or in $(BUILDDIR)/linkcheck/output.txt."
 
+.PHONY: doctest
 doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/docs/images/connected.png b/docs/_static/connected.png
index 7a9fac38..7a9fac38 100644
--- a/docs/images/connected.png
+++ b/docs/_static/connected.png
diff --git a/docs/images/cpu-wide.png b/docs/_static/cpu-wide.png
index 6d2cc697..6d2cc697 100644
--- a/docs/images/cpu-wide.png
+++ b/docs/_static/cpu-wide.png
diff --git a/docs/images/cpu.png b/docs/_static/cpu.png
index 7fa618a1..7fa618a1 100644
--- a/docs/images/cpu.png
+++ b/docs/_static/cpu.png
diff --git a/docs/images/disconnected.png b/docs/_static/disconnected.png
index d0bb15ee..d0bb15ee 100644
--- a/docs/images/disconnected.png
+++ b/docs/_static/disconnected.png
diff --git a/docs/images/diskio.png b/docs/_static/diskio.png
index bdc9c23e..bdc9c23e 100644
--- a/docs/images/diskio.png
+++ b/docs/_static/diskio.png
diff --git a/docs/images/docker.png b/docs/_static/docker.png
index 8584d33d..8584d33d 100644
--- a/docs/images/docker.png
+++ b/docs/_static/docker.png
diff --git a/docs/images/folders.png b/docs/_static/folders.png
index 17821154..17821154 100644
--- a/docs/images/folders.png
+++ b/docs/_static/folders.png
diff --git a/docs/images/fs.png b/docs/_static/fs.png
index d3c8464d..d3c8464d 100644
--- a/docs/images/fs.png
+++ b/docs/_static/fs.png
diff --git a/docs/images/glances-responsive-webdesign.png b/docs/_static/glances-responsive-webdesign.png
index a2b35e23..a2b35e23 100644
--- a/docs/images/glances-responsive-webdesign.png
+++ b/docs/_static/glances-responsive-webdesign.png
diff --git a/docs/_static/grafana.png b/docs/_static/grafana.png
new file mode 100644
index 00000000..4be55656
--- /dev/null
+++ b/docs/_static/grafana.png
diff --git a/docs/images/header.png b/docs/_static/header.png
index 33f1ba1d..33f1ba1d 100644
--- a/docs/images/header.png
+++ b/docs/_static/header.png
diff --git a/docs/images/load.png b/docs/_static/load.png
index bd80e6af..bd80e6af 100644
--- a/docs/images/load.png
+++ b/docs/_static/load.png
diff --git a/docs/images/logs.png b/docs/_static/logs.png
index 7a19fa3d..7a19fa3d 100644
--- a/docs/images/logs.png
+++ b/docs/_static/logs.png
diff --git a/docs/images/mem-wide.png b/docs/_static/mem-wide.png
index 838b959d..838b959d 100644
--- a/docs/images/mem-wide.png
+++ b/docs/_static/mem-wide.png
diff --git a/docs/images/mem.png b/docs/_static/mem.png
index aaf90ac4..aaf90ac4 100644
--- a/docs/images/mem.png
+++ b/docs/_static/mem.png
diff --git a/docs/images/monitored.png b/docs/_static/monitored.png
index 222425c6..222425c6 100644
--- a/docs/images/monitored.png
+++ b/docs/_static/monitored.png
diff --git a/docs/images/network.png b/docs/_static/network.png
index bb251be6..bb251be6 100644
--- a/docs/images/network.png
+++ b/docs/_static/network.png
diff --git a/docs/images/per-cpu.png b/docs/_static/per-cpu.png
index fbf48aab..fbf48aab 100644
--- a/docs/images/per-cpu.png
+++ b/docs/_static/per-cpu.png
diff --git a/docs/images/processlist-filter.png b/docs/_static/processlist-filter.png
index a804bf0f..a804bf0f 100644
--- a/docs/images/processlist-filter.png
+++ b/docs/_static/processlist-filter.png
diff --git a/docs/images/processlist-top.png b/docs/_static/processlist-top.png
index dd410c6d..dd410c6d 100644
--- a/docs/images/processlist-top.png
+++ b/docs/_static/processlist-top.png
diff --git a/docs/images/processlist-wide.png b/docs/_static/processlist-wide.png
index f8b80d1c..f8b80d1c 100644
--- a/docs/images/processlist-wide.png
+++ b/docs/_static/processlist-wide.png
diff --git a/docs/images/processlist.png b/docs/_static/processlist.png
index c2d1e83d..c2d1e83d 100644
--- a/docs/images/processlist.png
+++ b/docs/_static/processlist.png
diff --git a/docs/images/quicklook-percpu.png b/docs/_static/quicklook-percpu.png
index 4956fe7f..4956fe7f 100644
--- a/docs/images/quicklook-percpu.png
+++ b/docs/_static/quicklook-percpu.png
diff --git a/docs/images/quicklook.png b/docs/_static/quicklook.png
index bdee804b..bdee804b 100644
--- a/docs/images/quicklook.png
+++ b/docs/_static/quicklook.png
diff --git a/docs/images/raid.png b/docs/_static/raid.png
index fc9bd12b..fc9bd12b 100644
--- a/docs/images/raid.png
+++ b/docs/_static/raid.png
diff --git a/docs/_static/screenshot-web.png b/docs/_static/screenshot-web.png
new file mode 100644
index 00000000..d06f931f
--- /dev/null
+++ b/docs/_static/screenshot-web.png
diff --git a/docs/_static/screenshot-web2.png b/docs/_static/screenshot-web2.png
new file mode 100644
index 00000000..64ac5aab
--- /dev/null
+++ b/docs/_static/screenshot-web2.png
diff --git a/docs/_static/screenshot-wide.png b/docs/_static/screenshot-wide.png
new file mode 100644
index 00000000..a2a38a3d
--- /dev/null
+++ b/docs/_static/screenshot-wide.png
diff --git a/docs/images/screenshot.png b/docs/_static/screenshot.png
index 3d34a6d0..3d34a6d0 100644
--- a/docs/images/screenshot.png
+++ b/docs/_static/screenshot.png
diff --git a/docs/images/sensors.png b/docs/_static/sensors.png
index 588b5936..588b5936 100644
--- a/docs/images/sensors.png
+++ b/docs/_static/sensors.png
diff --git a/docs/_templates/links.html b/docs/_templates/links.html
new file mode 100644
index 00000000..db4302b3
--- /dev/null
+++ b/docs/_templates/links.html
@@ -0,0 +1,7 @@
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://pypi.python.org/pypi/Glances">Glances @ PyPI</a></li>
+  <li><a href="https://github.com/nicolargo/glances">Glances @ GitHub</a></li>
+  <li><a href="https://github.com/nicolargo/glances/issues">Issue Tracker</a></li>
+  <li><a href="https://groups.google.com/forum/#!forum/glances-users">Forum</a></li>
+</ul>
diff --git a/docs/aoa/actions.rst b/docs/aoa/actions.rst
new file mode 100644
index 00000000..5ce40bcd
--- /dev/null
+++ b/docs/aoa/actions.rst
@@ -0,0 +1,34 @@
+.. _actions:
+
+Actions
+=======
+
+Glances can trigger actions on events.
+
+By ``action``, we mean all shell command line. For example, if you want
+to execute the ``foo.py`` script if the last 5 minutes load are critical
+then add the ``_action`` line to the Glances configuration file:
+
+.. code-block:: ini
+
+    [load]
+    critical=5.0
+    critical_action=python /path/to/foo.py
+
+All the stats are available in the command line through the use of the
+`{{mustache}}`_ syntax. Another example would be to create a log file
+containing used vs total disk space if a space trigger warning is
+reached:
+
+.. code-block:: ini
+
+    [fs]
+    warning=70
+    warning_action=echo {{mnt_point}} {{used}}/{{size}} > /tmp/fs.alert
+
+.. note::
+    You can use all the stats for the current plugin. See
+    https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to
+    for the stats list.
+
+.. _{{mustache}}: https://mustache.github.io/
diff --git a/docs/aoa/cpu.rst b/docs/aoa/cpu.rst
new file mode 100644
index 00000000..8ac77855
--- /dev/null
+++ b/docs/aoa/cpu.rst
@@ -0,0 +1,41 @@
+.. _cpu:
+
+CPU
+===
+
+The CPU stats are shown as a percentage and for the configured refresh
+time. The total CPU usage is displayed on the first line.
+
+.. image:: ../_static/cpu.png
+
+If enough horizontal space is available, extended CPU information are
+displayed.
+
+.. image:: ../_static/cpu-wide.png
+
+To switch to per-CPU stats, just hit the ``1`` key:
+
+.. image:: ../_static/per-cpu.png
+
+By default, ``steal`` CPU time alerts aren't logged. If you want that,
+just add to the configuration file:
+
+.. code-block:: ini
+
+    [cpu]
+    steal_log=True
+
+Legend:
+</