ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 03:41:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Minor fixes to Developer Docs (#28302)

Browse source 
* Grammar and formatting corrections

Indent JSON code example.
Double backticks for inline code examples.

* Remove trailing spaces

* CI fixes
This commit is contained in:
Sam Doran 2017-08-16 20:56:53 -04:00 • committed by Matt Davis
parent 2960f5feac
commit b7aa38c0d8
2 changed files with 22 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -96,7 +96,7 @@ Version 1.1 of the metadata
+++++++++++++++++++++++++++
Structure
`````````
^^^^^^^^^
.. code-block:: python
@ -107,7 +107,7 @@ Structure
}
Fields
``````
^^^^^^
:metadata_version: An “X.Y” formatted string. X and Y are integers which
define the metadata format version. Modules shipped with Ansible are
@ -399,13 +399,15 @@ Put your completed module file into the ``lib/ansible/modules/$CATEGORY/`` direc
run the command: ``make webdocs``. The new 'modules.html' file will be
built in the ``docs/docsite/_build/html/$MODULENAME_module.html`` directory.
In order to speed up the build process, you can limit the documentation build to
In order to speed up the build process, you can limit the documentation build to
only include modules you specify, or no modules at all. To do this, run the command:
``MODULES=$MODULENAME make webdocs``. The ``MODULES`` environment variable
accepts a comma-separated list of module names. To skip building
documentation for all modules, specify a non-existent module name, for example:
``MODULES=none make webdocs``.
You may also build a single page of the entire docsite. From ``ansible/docs/docsite`` run ``make htmlsingle rst=[relative path to the .rst file]``, for example: ``make htmlsingle rst=dev_guide/developing_modules_documenting.rst``
To test your documentation against your ``argument_spec`` you can use ``validate-modules``. Note that this option isn't currently enabled in Shippable due to the time it takes to run.
.. code-block:: bash