Add ref to DebOps Contrib Documentation

Related to: #111

docs/Makefile

@@ -62,7 +62,7 @@ includes/global.rst: \
 		includes/45gen_debops_contrib_repos.rst \
 		includes/60gen_ypid_repos.rst \
 		FORCE_MAKE
-	run-parts --list --regex '.*\.rst' includes | grep -v 'global.rst$$' | xargs awk 'FNR==1{print ""}{print}' > "$@"
+	run-parts --list --regex '.*\.rst' includes | grep -v --extended-regexp '(global|all).rst$$' | xargs awk 'FNR==1{print ""}{print}' > "$@"
 
 includes/30gen_ansible_modules.rst: ./_bin/gen_ansible_modules_rst_defs
 	"$<" > "$@"

docs/conf.py

@@ -20,14 +20,15 @@
 import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+from subprocess import call
+call(['make', 'prepare'])
+call(['_bin/sphinx_conf_pre_hook'])
+
 sys.path.insert(0, os.path.abspath('_lib'))
 from sphinxcontrib import debops
 
 debops.yaml2rst_role_defaults('ansible/roles/')
 
-from subprocess import call
-call(['_bin/sphinx_conf_pre_hook'])
-
 # -- General configuration ------------------------------------------------
 
 suppress_warnings = ['image.nonlocal_uri']

docs/debops-contrib.rst

@@ -0,0 +1,8 @@
+Ansible roles provided in DebOps Contrib
+========================================
+
+.. include:: includes/all.rst
+
+Refer to the `DebOps Contrib Documentation`_.
+Note that DebOps Contrib components are no official part of DebOps_, but might
+be migrated to it in the future.

docs/includes/60gen_ypid_repos.rst

@@ -7,6 +7,7 @@
 .. _ypid.divert: https://github.com/ypid/ansible-divert
 .. _ypid.docker: https://github.com/ypid/ansible-docker
 .. _ypid.file_attributes: https://github.com/ypid/ansible-file_attributes
+.. _ypid.firejail: https://github.com/ypid/ansible-firejail
 .. _ypid.gdm: https://github.com/ypid/ansible-gdm
 .. _ypid.hdparm: https://github.com/ypid/ansible-hdparm
 .. _ypid.import_pgp_public_keys: https://github.com/ypid/ansible-import_pgp_public_keys

docs/includes/80post.rst

@@ -2,6 +2,9 @@
 
 .. DebOps project links [[[
 
+.. |debops_logo| image:: https://debops.org/images/debops-small.png
+
+
 .. Simply "DebOps" is preferred: https://github.com/debops/docs/issues/197
 .. _DebOps project: https://debops.org/
 
@@ -15,6 +18,7 @@
 .. _DebOps Playbooks: https://github.com/debops/debops-playbooks/
 .. _DebOps common playbook: https://github.com/debops/debops-playbooks/blob/master/playbooks/common.yml
 .. _DebOps Documentation: https://docs.debops.org/en/latest/
+.. _DebOps Contrib Documentation: https://docs.contrib.debops.org/en/latest/
 .. _DebOps Examples: https://github.com/debops/examples/
 .. _Getting Started with DebOps: https://docs.debops.org/en/latest/debops-playbooks/docs/guides/getting-started.html
 .. _DebOps Contrib: https://github.com/debops-contrib/debops-contrib

docs/includes/all.rst

@@ -0,0 +1 @@
+.. include:: includes/global.rst

docs/includes/global.rst

@@ -856,6 +856,7 @@
 .. _ypid.divert: https://github.com/ypid/ansible-divert
 .. _ypid.docker: https://github.com/ypid/ansible-docker
 .. _ypid.file_attributes: https://github.com/ypid/ansible-file_attributes
+.. _ypid.firejail: https://github.com/ypid/ansible-firejail
 .. _ypid.gdm: https://github.com/ypid/ansible-gdm
 .. _ypid.hdparm: https://github.com/ypid/ansible-hdparm
 .. _ypid.import_pgp_public_keys: https://github.com/ypid/ansible-import_pgp_public_keys
@@ -875,6 +876,9 @@
 
 .. DebOps project links [[[
 
+.. |debops_logo| image:: https://debops.org/images/debops-small.png
+
+
 .. Simply "DebOps" is preferred: https://github.com/debops/docs/issues/197
 .. _DebOps project: https://debops.org/
 
@@ -888,6 +892,7 @@
 .. _DebOps Playbooks: https://github.com/debops/debops-playbooks/
 .. _DebOps common playbook: https://github.com/debops/debops-playbooks/blob/master/playbooks/common.yml
 .. _DebOps Documentation: https://docs.debops.org/en/latest/
+.. _DebOps Contrib Documentation: https://docs.contrib.debops.org/en/latest/
 .. _DebOps Examples: https://github.com/debops/examples/
 .. _Getting Started with DebOps: https://docs.debops.org/en/latest/debops-playbooks/docs/guides/getting-started.html
 .. _DebOps Contrib: https://github.com/debops-contrib/debops-contrib

docs/index.rst

@@ -1,9 +1,11 @@
 |debops_logo| `DebOps <https://debops.org>`_ documentation
 ##########################################################
 
+.. include:: includes/all.rst
+
 **Your Debian-based data center in a box**
 
-A collection of `Ansible <https://ansible.com/>`_ playbooks,
+A collection of Ansible_ playbooks,
 scalable from one container to an entire data center.
 
 .. toctree::
@@ -16,11 +18,9 @@ scalable from one container to an entire data center.
    debops-keyring/docs/index.rst
    ansible/roles/index
    ansible/roles/ansible-*/docs/index
+   debops-contrib
    debops-api/docs/index
 
-
-.. |debops_logo| image:: https://debops.org/images/debops-small.png
-
 ..
  Local Variables:
  mode: rst