Fix panos_object docs so they generate properly (#35756)

Change description field to a list rather than folder scalar.

Cleanup formatting and line breaks in README.
This commit is contained in:
Sam Doran 2018-02-05 20:49:02 -05:00 committed by Chris Alfonso
parent 86c62e228d
commit 636ef65099
2 changed files with 8 additions and 22 deletions

View file

@ -3,33 +3,19 @@ Homepage and documentation source for Ansible
This project hosts the source behind [docs.ansible.com](http://docs.ansible.com/) This project hosts the source behind [docs.ansible.com](http://docs.ansible.com/)
Contributions to the documentation are welcome. To make changes, submit a pull request Contributions to the documentation are welcome. To make changes, submit a pull request that changes the reStructuredText files in the `rst/` directory only, and the core team can do a docs build and push the static files.
that changes the reStructuredText files in the "rst/" directory only, and the core team can
do a docs build and push the static files.
If you wish to verify output from the markup If you wish to verify output from the markup such as link references, you may install sphinx and build the documentation by running `make viewdocs` from the `ansible/docsite` directory.
such as link references, you may install sphinx and build the documentation by running
`make viewdocs` from the `ansible/docsite` directory.
To include module documentation you'll need to run `make webdocs` at the top level of the repository. The generated To include module documentation you'll need to run `make webdocs` at the top level of the repository. The generated html files are in `docsite/htmlout/`.
html files are in docsite/htmlout/.
To limit module documentation building to a specific module, run `MODULES=NAME To limit module documentation building to a specific module, run `MODULES=NAME make webdocs` instead. This should make testing module documentation syntax much faster. Instead of a single module, you can also specify a comma-separated list of modules. In order to skip building documentation for all modules, specify non-existing module name, for example `MODULES=none make webdocs`.
make webdocs` instead. This should make testing module documentation syntax much
faster. Instead of a single module, you can also specify a comma-separated list
of modules. In order to skip building documentation for all modules, specify
non-existing module name, for example `MODULES=none make webdocs`.
If you do not want to learn the reStructuredText format, you can also [file issues] about If you do not want to learn the reStructuredText format, you can also [file issues] about documentation problems on the Ansible GitHub project.
documentation problems on the Ansible GitHub project.
Note that module documentation can actually be [generated from a DOCUMENTATION docstring][module-docs] Note that module documentation can actually be [generated from a DOCUMENTATION docstring][module-docs] in the modules directory, so corrections to modules written as such need to be made in the module source, rather than in docsite source.
in the modules directory, so corrections to modules written as such need to be made
in the module source, rather than in docsite source.
To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme" To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme"
[file issues]: https://github.com/ansible/ansible/issues [file issues]: https://github.com/ansible/ansible/issues
[module-docs]: http://docs.ansible.com/developing_modules.html#documenting-your-module [module-docs]: http://docs.ansible.com/developing_modules.html#documenting-your-module

View file

@ -28,7 +28,7 @@ DOCUMENTATION = '''
--- ---
module: panos_object module: panos_object
short_description: create/read/update/delete object in PAN-OS or Panorama short_description: create/read/update/delete object in PAN-OS or Panorama
description: > description:
- Policy objects form the match criteria for policy rules and many other functions in PAN-OS. These may include - Policy objects form the match criteria for policy rules and many other functions in PAN-OS. These may include
address object, address groups, service objects, service groups, and tag. address object, address groups, service objects, service groups, and tag.
author: "Bob Hagen (@rnh556)" author: "Bob Hagen (@rnh556)"