ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-12 19:34:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Doc build warning/broken link clean-a-palooza (#37382)

Browse source 
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
This commit is contained in:
scottb 2018-03-14 12:44:21 -07:00 • committed by GitHub
commit 381359a8f8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
67 changed files with 289 additions and 230 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -188,7 +188,7 @@ The following fields can be used and are all required unless specified otherwise
:module:
The name of the module. This must be the same as the filename, without the ``.py`` extension.
:short_description:
* A short description which is displayed on the :doc:`../list_of_all_modules` page and ``ansible-doc -l``.
* A short description which is displayed on the :ref:`all_modules` page and ``ansible-doc -l``.
* As the short description is displayed by ``ansible-doc -l`` without the category grouping it needs enough detail to explain its purpose without the context of the directory structure in which it lives.
* Unlike ``description:`` this field should not have a trailing full stop.
:description: