Skip to content

Commit

Permalink
Add ref to DebOps Contrib Documentation
Browse files Browse the repository at this point in the history
Related to: debops#111
  • Loading branch information
ypid committed Nov 4, 2016
1 parent c7a5526 commit 42676f4
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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']
Expand Down
6 changes: 6 additions & 0 deletions docs/debops-contrib.rst
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/includes/60gen_ypid_repos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/includes/80post.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/includes/global.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down

0 comments on commit 42676f4

Please sign in to comment.