Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing module docs so they dont show up as a list on ansible docs. #37203

Merged
merged 2 commits into from
Mar 8, 2018

Conversation

jmighion
Copy link
Member

@jmighion jmighion commented Mar 8, 2018

SUMMARY

The docs for these 2 modules showed every character as a list on http://docs.ansible.com/

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

panos_nat_rule, panos_object

ANSIBLE VERSION
ansible 2.4.4 (panos_docs 878030c073) last updated 2018/03/08 08:54:32 (GMT -700)
  config file = None
  configured module search path = [u'/Users/james/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/james/Documents/git/ansible/lib/ansible
  executable location = /Users/james/Documents/git/ansible/bin/ansible
  python version = 2.7.14 (default, Feb  6 2018, 20:04:00) [GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.39.2)]

@ansibot
Copy link
Contributor

ansibot commented Mar 8, 2018

The test ansible-test sanity --test ansible-doc --python 2.7 [?] failed with the following error:

Command "ansible-doc panos_nat_rule panos_object" returned exit status 1.
>>> Standard Error
ERROR! module panos_nat_rule missing documentation (or could not parse documentation): Parsing produced an empty object.

The test ansible-test sanity --test ansible-doc --python 3.5 [?] failed with the following error:

Command "ansible-doc panos_nat_rule panos_object" returned exit status 1.
>>> Standard Error
ERROR! module panos_nat_rule missing documentation (or could not parse documentation): Parsing produced an empty object.

The test ansible-test sanity --test ansible-doc --python 2.6 [?] failed with the following error:

Command "ansible-doc panos_nat_rule panos_object" returned exit status 1.
>>> Standard Error
ERROR! module panos_nat_rule missing documentation (or could not parse documentation): Parsing produced an empty object.

The test ansible-test sanity --test ansible-doc --python 3.6 [?] failed with the following error:

Command "ansible-doc panos_nat_rule panos_object" returned exit status 1.
>>> Standard Error
ERROR! module panos_nat_rule missing documentation (or could not parse documentation): Parsing produced an empty object.

The test ansible-test sanity --test validate-modules [?] failed with the following errors:

lib/ansible/modules/network/panos/panos_nat_rule.py:17:1: E302 DOCUMENTATION is not valid YAML
lib/ansible/modules/network/panos/panos_object.py:34:1: E302 DOCUMENTATION is not valid YAML

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Mar 8, 2018

@ansibot ansibot added affects_2.4 This issue/PR affects Ansible v2.4 backport This PR does not target the devel branch. bug This issue/PR relates to a bug. module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. needs_triage Needs a first human triage before being processed. networking Network category support:community This issue/PR relates to code supported by the Ansible community. labels Mar 8, 2018
@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Mar 8, 2018
@ansibot ansibot added community_review In order to be merged, this PR must follow the community review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Mar 8, 2018
@abadger abadger merged commit df0f9d1 into ansible:stable-2.4 Mar 8, 2018
abadger pushed a commit to abadger/ansible that referenced this pull request Mar 8, 2018
…nsible#37203)

* Fixing module docs so they dont show up as a list on ansible docs.

* Fixing spacing in description.

(cherry picked from commit df0f9d1)
@abadger
Copy link
Contributor

abadger commented Mar 8, 2018

@jmighion One note for the future: please make Pull requests against devel first. Then we can cherry-pick (via PR or otherwise) after it's merged to devel. Committing to the stable branches first runs the risk of people not realizing that the change is not yet merged to devel and therefore the problem will come back on the next major release.

nitzmahone pushed a commit that referenced this pull request Mar 8, 2018
…37203) (#37218)

* Fixing module docs so they dont show up as a list on ansible docs.

* Fixing spacing in description.

(cherry picked from commit df0f9d1)
@gundalow
Copy link
Contributor

gundalow commented Mar 8, 2018

Oh, that's my fault. Seems to be OK in 2.5 & devel. I think the docs/template/ was updated to deal with it when the rst&html is generated.

@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.4 This issue/PR affects Ansible v2.4 backport This PR does not target the devel branch. bug This issue/PR relates to a bug. community_review In order to be merged, this PR must follow the community review workflow. module This issue/PR relates to a module. networking Network category support:community This issue/PR relates to code supported by the Ansible community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants