ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-05-31 21:39:10 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Fix Docs build issues (#22295)

Browse source 
* restore network docs fragments

* Fix RST errors

* code-block formatting
This commit is contained in:
John R Barker 2017-03-05 11:41:29 +00:00 • committed by GitHub
parent 6c2585f0c8
commit 3afb67e9b2
11 changed files with 397 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -35,7 +35,9 @@ ANSIBLE_METADATA Block
ANSIBLE_METADATA contains information about the module for use by other tools. At the moment, it informs other tools which type of maintainer the module has and to what degree users can rely on a module's behaviour remaining the same over time.
For new modules, the following block can be simply added into your module::
For new modules, the following block can be simply added into your module
.. code-block:: python
ANSIBLE_METADATA = {'status': ['preview'],
'supported_by': 'community',
@ -55,7 +57,7 @@ Version 1.0 of the metadata
Structure
`````````
Format::
.. code-block:: python
ANSIBLE_METADATA = {
'version': '1.0',
@ -298,11 +300,11 @@ built in the ``docs/docsite/_build/html/$MODULENAME_module.html`` directory.
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:: shell-session
.. code-block:: bash
# If you don't already, ensure you are using your local checkout
$ source hacking/env-setup
$ ./test/sanity/validate-modules/validate-modules --arg-spec --warnings lib/ansible/modules/your/modules/
source hacking/env-setup
./test/sanity/validate-modules/validate-modules --arg-spec --warnings lib/ansible/modules/your/modules/
.. tip::