Select & Implement an Auto-Documentation Tool

[cmlccie]

Select a tool that leverages the docstrings in the package's code to assist with building a live and complete set of package documentation.

Some possible tool options are available here.

Do others have experience or preference with or for any others?

[cmlccie]

Selected Sphinx; working on implementation.

Creating the following docs as part of this task:

• Introduction
• Tutorial
• User API Docs

[DJF3]

Great news.. Can't wait to see this documentation. Let me know if you want me to test it.

[cmlccie]

The user docs are mostly complete... Check out the recent commits to the development branch, your testing and feedback is very welcome. I hope to finish these up soon an move on to some other items.

[DJF3]

Sorry, I can provide feedback on documentation but couldn't really find that in the development branch (apologies, fairly new to github ;-)

[cmlccie]

No problem. They should be published shortly (within the next week). I appreciate your feedback when you have had a chance to review.

[cmlccie]

This one is complete! 😎

We are using Sphinx, and the docs are now available at ciscosparkapi.readthedocs.io. They are automatically updated with every push/pull to master.

Enjoy! Please raise an issue if you see any errors or opportunities for enhancement in the docs.