Rework for contrib

.gitmodules

@@ -355,15 +355,20 @@
 [submodule "docs/ansible/roles/ansible-users"]
 	path = docs/ansible/roles/ansible-users
 	url = https://github.com/debops/ansible-users
+	ignore = untracked
 [submodule "docs/ansible/roles/ansible-elasticsearch"]
 	path = docs/ansible/roles/ansible-elasticsearch
 	url = https://github.com/debops/ansible-elasticsearch
+	ignore = untracked
 [submodule "docs/ansible/roles/ansible-gunicorn"]
 	path = docs/ansible/roles/ansible-gunicorn
 	url = https://github.com/debops/ansible-gunicorn
+	ignore = untracked
 [submodule "docs/ansible/roles/ansible-netbox"]
 	path = docs/ansible/roles/ansible-netbox
 	url = https://github.com/debops/ansible-netbox
+	ignore = untracked
 [submodule "docs/ansible/roles/ansible-dnsmasq"]
 	path = docs/ansible/roles/ansible-dnsmasq
 	url = https://github.com/debops/ansible-dnsmasq
+	ignore = untracked

docs/.gitignore

@@ -1,2 +1,2 @@
 _build
-
+ansible/roles/includes

docs/Makefile

@@ -7,19 +7,14 @@ 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) .
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
-.PHONY: help clean distclean 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"
@@ -30,8 +25,10 @@ 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 "  epub3      to make an epub3"
 	@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"
@@ -45,7 +42,10 @@ help:
 	@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)"
+	@echo "  dummy      to check syntax errors of document sources"
 
+.PHONY: clean
 clean:
 	rm -rf $(BUILDDIR)/*
 
@@ -54,7 +54,7 @@ distclean:
 
 .PHONY: FORCE_MAKE
 
-prepare: includes/global.rst
+prepare:
 
 includes/global.rst: \
 		includes/30gen_ansible_modules.rst \
@@ -64,54 +64,61 @@ includes/global.rst: \
 		FORCE_MAKE
 	run-parts --list --regex '.*\.rst' includes | grep -v 'global.rst$$' | xargs awk 'FNR==1{print ""}{print}' > "$@"
 
-includes/30gen_ansible_modules.rst: ./bin/gen_ansible_modules_rst_defs
+includes/30gen_ansible_modules.rst: ./_bin/gen_ansible_modules_rst_defs
 	"$<" > "$@"
 
-includes/40gen_debops_api.rst: ./bin/gen_rst_defs_using_debops_api
+includes/40gen_debops_api.rst: ./_bin/gen_rst_defs_using_debops_api
 	"$<" --debops-api-query v0/roles/debops.json --role-owner 'debops' > "$@"
 
-includes/45gen_debops_contrib_repos.rst: ./bin/gen_rst_defs_using_remote_api
+includes/45gen_debops_contrib_repos.rst: ./_bin/gen_rst_defs_using_remote_api
 	"$<" 'github' 'DebOps Contrib' 'debops-contrib' 'orgs' > "$@"
 
-includes/60gen_ypid_repos.rst: ./bin/gen_rst_defs_using_remote_api
+includes/60gen_ypid_repos.rst: ./_bin/gen_rst_defs_using_remote_api
 	"$<" 'github' 'ypid' 'ypid' 'users' > "$@"
 
 # Run from conf.py
 .PHONY: linkincludes
-linkincludes: bin/linkincludes
+linkincludes: _bin/linkincludes
 	"$<"
 
+.PHONY: html
 html: prepare
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+.PHONY: dirhtml
 dirhtml: prepare
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 
+.PHONY: singlehtml
 singlehtml: prepare
 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 	@echo
 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 
+.PHONY: pickle
 pickle: prepare
 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 	@echo
 	@echo "Build finished; now you can process the pickle files."
 
+.PHONY: json
 json: prepare
 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 	@echo
 	@echo "Build finished; now you can process the JSON files."
 
+.PHONY: htmlhelp
 htmlhelp: prepare
 	$(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: prepare
 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 	@echo
@@ -121,6 +128,16 @@ qthelp: prepare
 	@echo "To view the help file:"
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DebOps.qhc"
 
+.PHONY: applehelp
+applehelp: prepare
+	$(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: prepare
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
@@ -130,80 +147,112 @@ devhelp: prepare
 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DebOps"
 	@echo "# devhelp"
 
+.PHONY: epub
 epub: prepare
 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 	@echo
 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 
+.PHONY: epub3
+epub3: prepare
+	$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+	@echo
+	@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
 latex: prepare
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 	@echo
 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 	      "(use \`make latexpdf' here to do that automatically)."
 
+.PHONY: latexpdf
 latexpdf: prepare
 	$(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: prepare
 	$(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: prepare
 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 	@echo
 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
 
+.PHONY: man
 man: prepare
 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 	@echo
 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 
+.PHONY: texinfo
 texinfo: prepare
 	$(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)."
 
+.PHONY: info
 info: prepare
 	$(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: prepare
 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 	@echo
 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 
+.PHONY: changes
 changes: prepare
 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 	@echo
 	@echo "The overview file is in $(BUILDDIR)/changes."
 
+.PHONY: linkcheck
 linkcheck: prepare
 	$(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: prepare
 	$(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: prepare
+	$(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: prepare
 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
 	@echo
 	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
 
+.PHONY: pseudoxml
 pseudoxml: prepare
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy: prepare
+	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+	@echo
+	@echo "Build finished. Dummy builder generates no files."

docs/bin/gen_ansible_modules_rst_defs → docs/_bin/gen_ansible_modules_rst_defs

@@ -7,7 +7,7 @@
 set -e
 
 echo '.. Ansible modules [[[
-.. This section was generated by: https://github.com/debops/docs/blob/master/docs/docs/bin/gen_ansible_modules_rst_defs
+.. This section was generated by: https://github.com/debops/docs/blob/master/docs/docs/_bin/gen_ansible_modules_rst_defs
 '
 
 ## dev/testing: `ansible-doc -l` needs to be cached because it is that freaking slow.

docs/bin/gen_rst_defs_using_debops_api → docs/_bin/gen_rst_defs_using_debops_api

@@ -5,7 +5,7 @@
 __license__ = 'GPL-3.0'
 __author__ = 'Robin Schneider <[email protected]>'
 __version__ = '0.1.0'
-SCRIPT_URL = 'https://github.com/debops/docs/blob/master/docs/docs/bin/gen_rst_defs_using_debops_api'
+SCRIPT_URL = 'https://github.com/debops/docs/blob/master/docs/docs/_bin/gen_rst_defs_using_debops_api'
 
 """
 Generate URL definitions based on data returned by the DebOps API.

docs/bin/gen_rst_defs_using_remote_api → docs/_bin/gen_rst_defs_using_remote_api

@@ -6,7 +6,7 @@
 
 set -e
 
-SCRIPT_URL='https://github.com/debops/docs/blob/master/docs/docs/bin/gen_rst_defs_using_remote_api'
+SCRIPT_URL='https://github.com/debops/docs/blob/master/docs/docs/_bin/gen_rst_defs_using_remote_api'
 
 get_defs_by_github_api_call() {
     ## Ref: https://developer.github.com/v3/repos/#list-user-repositories

docs/bin/linkincludes → docs/_bin/linkincludes

@@ -19,12 +19,18 @@ do
     ## ln: invalid option -- 'r'
     ## The version of ln on Travis does not have --relative :<
     ln -sf "$DOCS_DIR/includes/global.rst" global.rst
+
+    ## Should not be needed but for some reason when setting up DebOps Contrib,
+    ## it was needed for CHANGES.rst.
+    ln -sf "$DOCS_DIR/includes" ../../
+
     popd 1>/dev/null
     ## Print for debugging for now.
-    # 1>/dev/null
 done
 
+test -d ansible/roles && ln -sf ../../includes/ ansible/roles
+
 ## Seems that this hack is needed for Travis CI. Not sure why. For readthedocs.org it is not needed.
-ln -sf docs/includes debops-api/
-ln -sf docs/includes debops-keyring/
-ln -sf docs/includes debops-policy/
+test -d debops-api && ln -sf docs/includes debops-api/
+test -d debops-keyring && ln -sf docs/includes debops-keyring/
+test -d debops-policy && ln -sf docs/includes debops-policy/

docs/bin/sphinx_conf_pre_hook → docs/_bin/sphinx_conf_pre_hook

@@ -5,5 +5,5 @@
 ## Run hook scripts just before Sphinx runs.
 ## Hook is installed from `conf.py` from Sphinx.
 
-bin/linkincludes
-bin/prepare_repos_before_sphinx_runs
+_bin/linkincludes
+_bin/prepare_repos_before_sphinx_runs

docs/_lib/sphinxcontrib/debops/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from .func import *      # pylint: disable=wildcard-import