cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

clarify no subfolders and md only for collections /docs folder (#63808)

Browse source
This commit is contained in:
Sandra McCann 2019-10-22 16:50:02 -04:00 committed by Alicia Cozine
parent 56f52a0169
commit 6a2902c8d5
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docsite/rst/dev_guide/developing_collections.rst
View file

@ -60,7 +60,7 @@ See :ref:`collections_galaxy_meta` for details.
docs directory
---------------
Keep general documentation for the collection here. Plugins and modules still keep their specific documentation embedded as Python docstrings. Use the ``docs`` folder to describe how to use the roles and plugins the collection provides, role requirements, and so on. Currently we are looking at Markdown as the standard format for documentation files, but this is subject to change.
Put general documentation for the collection here. Keep the specific documentation for plugins and modules embedded as Python docstrings. Use the ``docs`` folder to describe how to use the roles and plugins the collection provides, role requirements, and so on. Use markdown and do not add subfolders.
Use ``ansible-doc`` to view documentation for plugins inside a collection: