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.

Sign up for GitHub

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

Jump to bottom

Add code to build documentation for napalm-ansible #535

Merged
merged 12 commits into from
Nov 24, 2017
Merged

Add code to build documentation for napalm-ansible #535

merged 12 commits into from
Nov 24, 2017

Conversation

ogenstad
Copy link
Contributor

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

  • The tables in the output aren't working and needs formatting.
  • Subheaders for each of the modules are included in the top tables of contents.

@ogenstad ogenstad mentioned this pull request Nov 18, 2017
Merged
@coveralls
Copy link

coveralls commented Nov 18, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 77.787% when pulling a396c5d on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

@ktbyers
Copy link
Contributor

ktbyers commented Nov 19, 2017

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 napalm-yang or napalm-logs -- will this be the structure?

How about put it after napalm-logs.

@dbarrosop
Copy link
Member

We can probably just add an "integrations" sections where we can document things like ansible, salt, st2, etc...

@ogenstad
Copy link
Contributor Author

Ok så in that case I'm thinking

/integrations/ansible/modules/napalm_cli
/integrations/ansible/modules/napalm_get_facts
etc.

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.

@coveralls
Copy link

coveralls commented Nov 19, 2017 •
edited
Loading

Coverage Status

Coverage increased (+0.02%) to 77.803% when pulling bc60f4b on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

@coveralls
Copy link

coveralls commented Nov 19, 2017 •
edited
Loading

Coverage Status

Coverage increased (+0.02%) to 77.803% when pulling 3402d7f on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

@coveralls
Copy link

coveralls commented Nov 19, 2017 •
edited
Loading

Coverage Status

Coverage increased (+0.02%) to 77.803% when pulling 956f08c on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

2 similar comments
@coveralls
Copy link

Coverage Status

Coverage increased (+0.02%) to 77.803% when pulling 956f08c on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.02%) to 77.803% when pulling 956f08c on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

@dbarrosop
Copy link
Member

nice! :D

@coveralls
Copy link

Coverage Status

Coverage increased (+0.3%) to 78.109% when pulling d305508 on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

1 similar comment
@coveralls
Copy link

coveralls commented Nov 21, 2017 •
edited
Loading

Coverage Status

Coverage increased (+0.3%) to 78.109% when pulling d305508 on ogenstad:ansible_docs into 136c335 on napalm-automation:develop.

@ogenstad ogenstad changed the title WIP: Add code to build documentation for napalm-ansible Add code to build documentation for napalm-ansible Nov 21, 2017
@ogenstad
Copy link
Contributor Author

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.

@coveralls
Copy link

coveralls commented Nov 21, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 78.109% when pulling e9f21c8 on ogenstad:ansible_docs into 3ef2a1a on napalm-automation:develop.

@ogenstad ogenstad mentioned this pull request Nov 21, 2017
Open
@mirceaulinic mirceaulinic requested a review from a team November 23, 2017 10:52
@mirceaulinic mirceaulinic added this to the APPROVED milestone Nov 23, 2017
@coveralls
Copy link

coveralls commented Nov 24, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 78.604% when pulling 224ab8d on ogenstad:ansible_docs into 08dfe0d on napalm-automation:develop.

@dbarrosop dbarrosop merged commit e51aa58 into napalm-automation:develop Nov 24, 2017
@ogenstad ogenstad deleted the ansible_docs branch November 24, 2017 12:11
dbarrosop added a commit that referenced this pull request Nov 24, 2017
@dbarrosop
Release 2.2.0 (#560)
21f675e 
* 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
@dbarrosop @cspeidel
Release 2.2.0 (napalm-automation#560)
eabb752 
* 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
Reviewers

@dbarrosop dbarrosop dbarrosop approved these changes

Assignees
No one assigned
Labels
awesome documentation enhancement
Projects
None yet
Milestone
APPROVED
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@ogenstad @coveralls @ktbyers @dbarrosop @mirceaulinic