Ansible documentation #10
Comments
ogenstad
added a commit
to ogenstad/napalm-ansible
that referenced
this issue
Nov 17, 2017
This is for the 2017 Hackathon napalm-automation/hackathon-2017#10 This commit validates that each Ansible module has a DOCUMENTATION and an EXAMPLES variable. It also asserts that those variables are properly formatted YAML strings.
ogenstad
added a commit
to ogenstad/napalm-ansible
that referenced
this issue
Nov 17, 2017
This is for the 2017 Hackathon napalm-automation/hackathon-2017#10 This commit validates that each Ansible module has a DOCUMENTATION and an EXAMPLES variable. It also asserts that those variables are properly formatted YAML strings.
ogenstad
added a commit
to ogenstad/napalm-ansible
that referenced
this issue
Nov 17, 2017
This is for the 2017 Hackathon napalm-automation/hackathon-2017#10 This commit validates that each Ansible module has a DOCUMENTATION and an EXAMPLES variable. It also asserts that those variables are properly formatted YAML strings.
ogenstad
added a commit
to ogenstad/napalm-ansible
that referenced
this issue
Nov 20, 2017
This is for the 2017 Hackathon napalm-automation/hackathon-2017#10 This commit validates that each Ansible module has a DOCUMENTATION and an EXAMPLES variable. It also asserts that those variables are properly formatted YAML strings.
dbarrosop
pushed a commit
to napalm-automation/napalm-ansible
that referenced
this issue
Nov 21, 2017
* Add tests for documentation This is for the 2017 Hackathon napalm-automation/hackathon-2017#10 This commit validates that each Ansible module has a DOCUMENTATION and an EXAMPLES variable. It also asserts that those variables are properly formatted YAML strings. * Add formatting test for EXAMPLES * Fix EXAMPLES variables so they are valid YAML * Generate json files with documentation for modules Content for the RETURN variable will be added later. * Add tests for YAML parsing of RETURN variables * Add tests for content in documentation * Run pytest from Travis * Make pylama happy again * Install napalm_ansible package * Add tests for EXAMPLES and change output format * Documentation fixes * Rename variable * Documentation fixes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
All of the modules in https://github.com/napalm-automation/napalm-ansible have documentation in the same way that the modules within Ansible does.
However unlike Ansible the documentation isn't available online outside of the source code. For the hackathon we could use this information to publish the documentation on https://napalm.readthedocs.io/en/latest/.
For this to happen we need to create tests to validate format of the current documentation and create a hook in Travis so that a new release of the Ansible modules would trigger a new build of the documentation for the https://github.com/napalm-automation/napalm repo.
The text was updated successfully, but these errors were encountered: