Add code to build documentation for napalm-ansible #535
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I don't have that much preference here (for where to put the documents). What about making a napalm-ansible section and then do something similar to How about put it after |
|
We can probably just add an "integrations" sections where we can document things like ansible, salt, st2, etc... |
|
Ok så in that case I'm thinking /integrations/ansible/modules/napalm_cli That way we can also have /integrations/ansible/installation, and I saw some PR in napalm-ansible about adding action plugins. The above structure would make it easy to add that without having to change the urls. The downside is that it might feel like the modules are a bit deep down in the tree before other content is added. |
2 similar comments
|
nice! :D |
1 similar comment
ogenstad
changed the title
|
Thanks @dbarrosop! This one is ready for review now. Later it wouldn't hurt if the actual text in the documentation was improved a bit and more verifications can be done in the napalm-ansible repo. But this should build correctly now. |
dbarrosop
approved these changes
Nov 24, 2017
dbarrosop
added a commit
that referenced
this pull request
Nov 24, 2017
* Canonical interfaces fix dictionary update behavior. * Fixing argument reference. * Fixing NXOS file write issue Python3 * Added mocking method for nxos * add tests for and fix canonical name * add optional arg, and re-order optional args * create extend driver docs * clean up docs, add to index * update doc strings * fix pylama * fix rev update dict * add section headers * spelling * more consitent test, fix st * Fix nxos_ssh mac table processing bug * adding optional arguments for load_replace_candidate (#508) * adding optional arguments for load_replace_candidate and load_merge_candidate * adding optional argument 'autoComplete' * adding optional argument 'autoComplete' changing failed tests * making required changes as discussed * changing the if condition * correcting the typo * Handle multiple spaces in device_id from show lldp neighbors * Add test to get_lldp_neighbors with hostname with spaces * Loop through loaded config to convert HEREDOC commands. Fixes #519 (#520) (eos) loop through loaded config to convert HEREDOC commands. Fixes #519 * Add code to build documentation for napalm-ansible (#535) * Add code to build documentation for napalm-ansible * pep8 * Change placement in documentation tree * Change formatting * Fix formatting for return values * Sort parameters alphabetically * Text changes * Add script to clone napalm-ansible repo * remove partial install (#554) * Update documentation to corrrect driver ref (#559) * [docs] Add "-c /dev/null" arguments to py.test command (#561) (#562) * Add "-c /dev/null" arguments to py.test command (#561) Before the NAPALM tests were picked up when running from RTD. * fix requirements filepaths * LLDP code with space in the device id (#549) * LLDP code with space in the device id * LLDP fixed width for device_id field
cspeidel
pushed a commit
to cspeidel/napalm
that referenced
this pull request
Nov 11, 2018
* Canonical interfaces fix dictionary update behavior. * Fixing argument reference. * Fixing NXOS file write issue Python3 * Added mocking method for nxos * add tests for and fix canonical name * add optional arg, and re-order optional args * create extend driver docs * clean up docs, add to index * update doc strings * fix pylama * fix rev update dict * add section headers * spelling * more consitent test, fix st * Fix nxos_ssh mac table processing bug * adding optional arguments for load_replace_candidate (napalm-automation#508) * adding optional arguments for load_replace_candidate and load_merge_candidate * adding optional argument 'autoComplete' * adding optional argument 'autoComplete' changing failed tests * making required changes as discussed * changing the if condition * correcting the typo * Handle multiple spaces in device_id from show lldp neighbors * Add test to get_lldp_neighbors with hostname with spaces * Loop through loaded config to convert HEREDOC commands. Fixes napalm-automation#519 (napalm-automation#520) (eos) loop through loaded config to convert HEREDOC commands. Fixes napalm-automation#519 * Add code to build documentation for napalm-ansible (napalm-automation#535) * Add code to build documentation for napalm-ansible * pep8 * Change placement in documentation tree * Change formatting * Fix formatting for return values * Sort parameters alphabetically * Text changes * Add script to clone napalm-ansible repo * remove partial install (napalm-automation#554) * Update documentation to corrrect driver ref (napalm-automation#559) * [docs] Add "-c /dev/null" arguments to py.test command (napalm-automation#561) (napalm-automation#562) * Add "-c /dev/null" arguments to py.test command (napalm-automation#561) Before the NAPALM tests were picked up when running from RTD. * fix requirements filepaths * LLDP code with space in the device id (napalm-automation#549) * LLDP code with space in the device id * LLDP fixed width for device_id field
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will add documentation for napalm-ansible modules.
It's related to this issue for the Hackathon - napalm-automation/hackathon-2017#10 and depends on this PR getting merged napalm-automation/napalm-ansible#106
Currently there's no script to git clone the napalm-ansible modules and will currently fail.
Up for discussion is where in the documentation tree to put these things.
Current problems