diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst index f2e1fb6eb7f..d3fb4f7fcad 100644 --- a/docs/docsite/rst/dev_guide/developing_collections.rst +++ b/docs/docsite/rst/dev_guide/developing_collections.rst @@ -16,6 +16,7 @@ You can create a collection and publish it to `Ansible Galaxy `_ of the :ref:`sensu.sensu_go.install role ` on GitHub. + +.. _build_collection_docsite: + +Build a docsite with antsibull-docs +=================================== + +You can use `antsibull-docs `_ to build a Sphinx-based docsite for your collection: + +#. Create your collection and make sure you can use it with ansible-core by adding it to your :ref:`COLLECTIONS_PATHS`. +#. Create a directory ``dest`` and run ``antsibull-docs sphinx-init --use-current --dest-dir dest namespace.name``, where ``namespace.name`` is the name of your collection. +#. Go into ``dest`` and run ``pip -r requirements.txt``. You might want to create a venv and activate it first to avoid installing this globally. +#. Then run ``./build.sh``. +#. Open ``build/html/index.html`` in a browser of your choice. + +If you want to add additional documentation to your collection next to the plugin, module, and role documentation, see :ref:`collections_doc_dir`. diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index 9bd9cbd461a..081f7493b0f 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -447,4 +447,4 @@ The use of "wildcard" imports such as ``from module_utils.basic import *`` is no Testing module documentation ============================ -To test Ansible documentation locally please :ref:`follow instruction`. +To test Ansible documentation locally please :ref:`follow instruction`. To test documentation in collections, please see :ref:`build_collection_docsite`. diff --git a/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst b/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst index 548b55261a5..1a7da5f50b7 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst @@ -246,6 +246,8 @@ You can pass other keywords, including variables and tags, when importing roles: When you add a tag to an ``import_role`` statement, Ansible applies the tag to `all` tasks within the role. See :ref:`tag_inheritance` for details. +.. _role_argument_spec: + Role argument validation ========================