From 42676f441c198904f0f8ac854c37942fd949d1ed Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Fri, 4 Nov 2016 22:31:40 +0100 Subject: [PATCH] Add ref to DebOps Contrib Documentation Related to: #111 --- docs/conf.py | 7 ++++--- docs/debops-contrib.rst | 6 ++++++ docs/includes/60gen_ypid_repos.rst | 1 + docs/includes/80post.rst | 1 + docs/includes/global.rst | 2 ++ docs/index.rst | 1 + 6 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 docs/debops-contrib.rst diff --git a/docs/conf.py b/docs/conf.py index 32dbad9..8f0ce2e 100644 --- a/docs/conf.py +++ b/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'] diff --git a/docs/debops-contrib.rst b/docs/debops-contrib.rst new file mode 100644 index 0000000..2c7677c --- /dev/null +++ b/docs/debops-contrib.rst @@ -0,0 +1,6 @@ +Ansible roles provided in DebOps Contrib +======================================== + +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. diff --git a/docs/includes/60gen_ypid_repos.rst b/docs/includes/60gen_ypid_repos.rst index 5b83b89..4e0b5e5 100644 --- a/docs/includes/60gen_ypid_repos.rst +++ b/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 diff --git a/docs/includes/80post.rst b/docs/includes/80post.rst index d52d43c..bb0e264 100644 --- a/docs/includes/80post.rst +++ b/docs/includes/80post.rst @@ -15,6 +15,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 diff --git a/docs/includes/global.rst b/docs/includes/global.rst index 9f8a856..40515a1 100644 --- a/docs/includes/global.rst +++ b/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 @@ -888,6 +889,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 diff --git a/docs/index.rst b/docs/index.rst index 1f476a2..d03e177 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,7 @@ 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