internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 05:42:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs about contributing to docs (#46481)

Browse Source 
* adds page on community contributions to docs
This commit is contained in:
Alicia Cozine
2018-10-24 10:14:01 -05:00
committed by Sandra McCann
parent e58e43279c
commit 4219d25fc7
7 changed files with 188 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docsite/rst/dev_guide/testing_documentation.rst
View File

@@ -1,12 +1,12 @@
:orphan:
.. _testing_documentation:
.. _testing_module_documentation:
*********************
Testing documentation
*********************
****************************
Testing module documentation
****************************
Before you submit a module for inclusion in the main Ansible repo, you must test your documentation for correct HTML rendering and to ensure that the argspec matches the documentation.
Before you submit a module for inclusion in the main Ansible repo, you must test your module documentation for correct HTML rendering and to ensure that the argspec matches the documentation in your Python file. The community pages offer more information on :ref:`testing reStructuredText documentation <testing_documentation_locally>`.
To check the HTML output of your module documentation: