From 636ef65099627484686256b3bc54951434a03be7 Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Mon, 5 Feb 2018 20:49:02 -0500 Subject: [PATCH] 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. --- docs/docsite/README.md | 26 +++++-------------- .../modules/network/panos/panos_object.py | 4 +-- 2 files changed, 8 insertions(+), 22 deletions(-) diff --git a/docs/docsite/README.md b/docs/docsite/README.md index 7ddea776fc..6075c8a66f 100644 --- a/docs/docsite/README.md +++ b/docs/docsite/README.md @@ -3,33 +3,19 @@ Homepage and documentation source for Ansible 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 -that changes the reStructuredText files in the "rst/" directory only, and the core team can -do a docs build and push the static files. +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. -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. +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. -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/. +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/`. -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`. +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`. -If you do not want to learn the reStructuredText format, you can also [file issues] about -documentation problems on the Ansible GitHub project. +If you do not want to learn the reStructuredText format, you can also [file issues] about documentation problems on the Ansible GitHub project. -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. +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. 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 [module-docs]: http://docs.ansible.com/developing_modules.html#documenting-your-module - - diff --git a/lib/ansible/modules/network/panos/panos_object.py b/lib/ansible/modules/network/panos/panos_object.py index 254e726613..2de67c268e 100644 --- a/lib/ansible/modules/network/panos/panos_object.py +++ b/lib/ansible/modules/network/panos/panos_object.py @@ -28,9 +28,9 @@ DOCUMENTATION = ''' --- module: panos_object 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 - address object, address groups, service objects, service groups, and tag. + address object, address groups, service objects, service groups, and tag. author: "Bob Hagen (@rnh556)" version_added: "2.4" requirements: