From 0d26c5fe7529f867063b28fc94d78f471451a2ba Mon Sep 17 00:00:00 2001 From: Boris Glimcher Date: Wed, 14 Feb 2024 20:37:49 +0200 Subject: [PATCH] docs: running antsibull-docs first time ``` antsibull-docs collection --use-current --squash-hierarchy --dest-dir ./docs/ opi.dpu ``` Signed-off-by: Boris Glimcher --- docs/environment_variables.rst | 15 ++++++++++ docs/index.rst | 52 ++++++++++++++++++++++++++++++++++ meta/runtime.yml | 2 +- requirements.txt | 2 ++ requirements.yml | 1 - 5 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 docs/environment_variables.rst create mode 100644 docs/index.rst diff --git a/docs/environment_variables.rst b/docs/environment_variables.rst new file mode 100644 index 0000000..d5466fe --- /dev/null +++ b/docs/environment_variables.rst @@ -0,0 +1,15 @@ + +:orphan: + +.. meta:: + :antsibull-docs: 2.7.0 + +.. _list_of_collection_env_vars: + +Index of all Collection Environment Variables +============================================= + +The following index documents all environment variables declared by plugins in collections. +Environment variables used by the ansible-core configuration are documented in :ref:`ansible_configuration_settings`. + +No environment variables have been defined. diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7c271d5 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,52 @@ + + +.. meta:: + :antsibull-docs: 2.7.0 + + +.. _plugins_in_opi.dpu: + +Opi.Dpu +======= + +Collection version 1.0.0 + +.. contents:: + :local: + :depth: 1 + +Description +----------- + +Ansible modules for DPUs + +**Author:** + +* OPI Memebers + +**Supported ansible-core versions:** + +* 2.9.10 or newer + +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/opiproject/ansible-opi-dpu/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/opiproject/ansible-opi-dpu" + external: true + + + + +.. toctree:: + :maxdepth: 1 + + +Plugin Index +------------ + +There are no plugins in the opi.dpu collection with automatically generated documentation. + + diff --git a/meta/runtime.yml b/meta/runtime.yml index 20f709e..1b573f6 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,7 +1,7 @@ --- # Collections must specify a minimum required ansible version to upload # to galaxy -# requires_ansible: '>=2.9.10' +requires_ansible: '>=2.14.0' # Content that Ansible needs to load from another location or that has # been deprecated/removed diff --git a/requirements.txt b/requirements.txt index 6fe7292..08e1bfb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,3 @@ python-dateutil>=2.8.2 +antsibull-docs>=2.7.0 +ansible-lint>=6.22.2 \ No newline at end of file diff --git a/requirements.yml b/requirements.yml index bf21cca..8dd5161 100644 --- a/requirements.yml +++ b/requirements.yml @@ -1,4 +1,3 @@ --- collections: - - opi.dpu - community.general