From 895898db2d66949727049a394d80c765aa8d8c95 Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Fri, 4 Nov 2016 22:31:40 +0100 Subject: [PATCH 1/3] Add ref to DebOps Contrib Documentation Related to: #111 --- docs/Makefile | 2 +- docs/conf.py | 7 ++++--- docs/debops-contrib.rst | 8 ++++++++ docs/includes/60gen_ypid_repos.rst | 1 + docs/includes/80post.rst | 4 ++++ docs/includes/all.rst | 1 + docs/includes/global.rst | 5 +++++ docs/index.rst | 10 +++++----- 8 files changed, 29 insertions(+), 9 deletions(-) create mode 100644 docs/debops-contrib.rst create mode 100644 docs/includes/all.rst diff --git a/docs/Makefile b/docs/Makefile index f68a3d1..641a965 100644 --- a/docs/Makefile +++ b/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 "$<" > "$@" 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..ad6483a --- /dev/null +++ b/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. 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..cd30723 100644 --- a/docs/includes/80post.rst +++ b/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 diff --git a/docs/includes/all.rst b/docs/includes/all.rst new file mode 100644 index 0000000..73b2598 --- /dev/null +++ b/docs/includes/all.rst @@ -0,0 +1 @@ +.. include:: includes/global.rst diff --git a/docs/includes/global.rst b/docs/includes/global.rst index 9f8a856..9691a33 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 @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 1f476a2..e9aeaa7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,11 @@ -|debops_logo| `DebOps `_ documentation +|debops_logo| DebOps_ documentation ########################################################## +.. include:: includes/all.rst + **Your Debian-based data center in a box** -A collection of `Ansible `_ 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 From 2c16660cc7aad93113e268ac4eac5907587e5d42 Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Sat, 5 Nov 2016 21:19:41 +0100 Subject: [PATCH 2/3] Fix underline heading marks --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index e9aeaa7..73ffb71 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ |debops_logo| DebOps_ documentation -########################################################## +################################### .. include:: includes/all.rst From 8666b257583a86fd901ba75617cc187199f44f0d Mon Sep 17 00:00:00 2001 From: Robin Schneider Date: Sat, 19 Nov 2016 23:31:25 +0100 Subject: [PATCH 3/3] Revert `|debops_logo| image` move to global.rst. Seems not to work. Related to: https://github.com/debops/docs/pull/245 --- docs/includes/80post.rst | 3 --- docs/includes/global.rst | 3 --- docs/index.rst | 8 ++++++-- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/includes/80post.rst b/docs/includes/80post.rst index cd30723..bb0e264 100644 --- a/docs/includes/80post.rst +++ b/docs/includes/80post.rst @@ -2,9 +2,6 @@ .. 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/ diff --git a/docs/includes/global.rst b/docs/includes/global.rst index 9691a33..40515a1 100644 --- a/docs/includes/global.rst +++ b/docs/includes/global.rst @@ -876,9 +876,6 @@ .. 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/ diff --git a/docs/index.rst b/docs/index.rst index 73ffb71..fa80a61 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,6 @@ |debops_logo| DebOps_ documentation ################################### -.. include:: includes/all.rst - **Your Debian-based data center in a box** A collection of Ansible_ playbooks, @@ -21,6 +19,12 @@ scalable from one container to an entire data center. debops-contrib debops-api/docs/index + +.. Seems that includes don’t work for images? Define them here. +.. |debops_logo| image:: https://debops.org/images/debops-small.png + +.. include:: includes/all.rst + .. Local Variables: mode: rst