Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Documentation #16

Closed
crisidev opened this issue Jul 23, 2017 · 5 comments
Closed

Documentation #16

crisidev opened this issue Jul 23, 2017 · 5 comments

Comments

@crisidev
Copy link
Collaborator

crisidev commented Jul 23, 2017

I think what is missing now is a more structured documentation, especially as inline, with sphinx autogeneration and automatic push to readthedocs.

@ryanpetrello do you guys have an account on readthedocs? The sphinx generation part is quite easy to implement thou..

Regarding the inline documentation, here is the status:

tacacs_plus/flags.py - not documented
tacacs_plus/accounting.py - not documented
tacacs_plus/authentication.py - not documented
tacacs_plus/authorization.py - not documented
tacacs_plus/client.py - documented
tacacs_plus/flags.py - not documented
tacacs_plus/packet.py - not documented

Thoughts?

@ryanpetrello
Copy link
Contributor

@crisidev no RTD account, but I'm comfortable enough w/ sphinx to set this up (if we actually had thorough docs, which we currently don't)

@crisidev
Copy link
Collaborator Author

crisidev commented Aug 2, 2017

I can set this up, no problem. You just have to create the RTD account. On my local machine I can already generate doc for what we have documented. It can be a work in progress and improved ongoing :)

@crisidev
Copy link
Collaborator Author

crisidev commented Aug 8, 2017

Implemented here: #18

@ryanpetrello
Copy link
Contributor

@crisidev
Copy link
Collaborator Author

crisidev commented Aug 9, 2017

Nice :D Now the doc is to be written, which is tedious :D

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants