Adding in Ansible (still a WIP).
This commit is contained in:
@@ -0,0 +1,7 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
/temp-rst
|
||||
/build
|
||||
/rst/collections
|
||||
+22
@@ -0,0 +1,22 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
breadcrumbs = true
|
||||
indexes = true
|
||||
use_html_blobs = false
|
||||
|
||||
# You can specify ways to convert a collection name (<namespace>.<name>) to an URL here.
|
||||
# You can replace either of <namespace> or <name> by "*" to match all values in that place,
|
||||
# or use "*" for the collection name to match all collections. In the URL, you can use
|
||||
# {namespace} and {name} for the two components of the collection name. If you want to use
|
||||
# "{" or "}" in the URL, write "{{" or "}}" instead. Basically these are Python format
|
||||
# strings (https://docs.python.org/3.8/library/string.html#formatstrings).
|
||||
collection_url = {
|
||||
* = "https://galaxy.ansible.com/{namespace}/{name}"
|
||||
}
|
||||
|
||||
# The same wildcard rules and formatting rules as for collection_url apply.
|
||||
collection_install = {
|
||||
* = "ansible-galaxy collection install {namespace}.{name}"
|
||||
}
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
set -e
|
||||
pushd "${BASH_SOURCE%/*}"
|
||||
|
||||
# Create collection documentation into temporary directory
|
||||
rm -rf temp-rst
|
||||
mkdir -p temp-rst
|
||||
antsibull-docs \
|
||||
--config-file antsibull-docs.cfg \
|
||||
collection \
|
||||
--use-current \
|
||||
--dest-dir temp-rst \
|
||||
community.hashi_vault
|
||||
|
||||
# Copy collection documentation into source directory
|
||||
rsync -cprv --delete-after temp-rst/collections/ rst/collections/
|
||||
|
||||
# Build Sphinx site
|
||||
sphinx-build -M html rst build -c . -W --keep-going
|
||||
|
||||
popd
|
||||
@@ -0,0 +1,42 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
# This file only contains a selection of the most common options. For a full list see the
|
||||
# documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
project = 'Ansible collections'
|
||||
copyright = 'Ansible contributors'
|
||||
|
||||
title = 'Ansible Collections Documentation'
|
||||
html_short_title = 'Ansible Collections Documentation'
|
||||
|
||||
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx_antsibull_ext']
|
||||
|
||||
pygments_style = 'ansible'
|
||||
|
||||
highlight_language = 'YAML+Jinja'
|
||||
|
||||
html_theme = 'sphinx_ansible_theme'
|
||||
html_show_sphinx = False
|
||||
|
||||
display_version = False
|
||||
|
||||
html_use_smartypants = True
|
||||
html_use_modindex = False
|
||||
html_use_index = False
|
||||
html_copy_source = False
|
||||
|
||||
intersphinx_mapping = {
|
||||
'python': ('https://docs.python.org/2/', (None, '../python2.inv')),
|
||||
'python3': ('https://docs.python.org/3/', (None, '../python3.inv')),
|
||||
'jinja2': ('http://jinja.palletsprojects.com/', (None, '../jinja2.inv')),
|
||||
'ansible_devel': ('https://docs.ansible.com/ansible/devel/', (None, '../ansible_devel.inv')),
|
||||
# If you want references to resolve to a released Ansible version (say, `5`), uncomment and replace X by this version:
|
||||
# 'ansibleX': ('https://docs.ansible.com/ansible/X/', (None, '../ansibleX.inv')),
|
||||
}
|
||||
|
||||
default_role = 'any'
|
||||
|
||||
nitpicky = True
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
antsibull-docs >= 1.0.0, < 2.0.0
|
||||
ansible-pygments
|
||||
sphinx != 5.2.0.post0 # temporary, see https://github.com/ansible-community/antsibull-docs/issues/39, https://github.com/ansible-community/antsibull-docs/issues/40
|
||||
sphinx-ansible-theme >= 0.9.0
|
||||
+25
@@ -0,0 +1,25 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
.. _docsite_root_index:
|
||||
|
||||
Ansible collection documentation preview
|
||||
========================================
|
||||
|
||||
This docsite contains documentation for ``community.hashi_vault``.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Collections:
|
||||
|
||||
collections/index
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Plugin indexes:
|
||||
:glob:
|
||||
|
||||
collections/index_*
|
||||
Reference in New Issue
Block a user