doc update

Author: FabriceSalvaire

doc/sphinx/Makefile.sphinx

@@ -1,3 +1,4 @@
+# -*- Makefile -*-
 # Makefile for Sphinx documentation
 #
 
@@ -7,19 +8,13 @@ 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
 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+CLIENTSOPTS = -D master_doc=contents-client
 
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 
 help:
 @echo "Please use \`make <target>' where <target> is one of"
@@ -30,32 +25,29 @@ 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)"
 
 clean:
-rm -rf $(BUILDDIR)/*
+-rm -rf $(BUILDDIR)/*
 
 html:
 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 @echo
 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+htmlclient:
+$(SPHINXBUILD) -b html $(CLIENTSOPTS) $(ALLSPHINXOPTS) $(BUILDDIR)/html-client
+@echo
+@echo "Build finished. The HTML pages are in $(BUILDDIR)/html-client."
+
 dirhtml:
 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 @echo
@@ -87,25 +79,17 @@ qthelp:
 @echo
 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SimAVR.qhcp"
+@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GVLab.qhcp"
 @echo "To view the help file:"
-@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SimAVR.qhc"
-
-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."
+@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GVLab.qhc"
 
 devhelp:
 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 @echo
 @echo "Build finished."
 @echo "To view the help file:"
-@echo "# mkdir -p $$HOME/.local/share/devhelp/SimAVR"
-@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SimAVR"
+@echo "# mkdir -p $$HOME/.local/share/devhelp/GVLab"
+@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GVLab"
 @echo "# devhelp"
 
 epub:
@@ -123,13 +107,7 @@ latex:
 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."
-
-latexpdfja:
-$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-@echo "Running LaTeX files through platex and dvipdfmx..."
-$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+make -C $(BUILDDIR)/latex all-pdf
 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
 text:
@@ -142,24 +120,6 @@ man:
 @echo
 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
-texinfo:
-$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-@echo
-@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
-@echo "Run \`make' in that directory to run these through makeinfo" \
- "(use \`make info' here to do that automatically)."
-
-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."
-
-gettext:
-$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-@echo
-@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
 changes:
 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 @echo
@@ -175,18 +135,3 @@ doctest:
 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 @echo "Testing of doctests in the sources finished, look at the " \
  "results in $(BUILDDIR)/doctest/output.txt."
-
-coverage:
-$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
-@echo "Testing of coverage in the sources finished, look at the " \
- "results in $(BUILDDIR)/coverage/python.txt."
-
-xml:
-$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
-@echo
-@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
-$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
-@echo
-@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

doc/sphinx/make-html

@@ -1,6 +1,3 @@
 #! /bin/bash
 
 make -f Makefile.sphinx html
-# xdg-open build/html/index.html
-
-# End