Open gschneider-r7 opened 7 years ago
Verify: Make sure all source-based docs are suitable for use with doc tools. A probably useful reference: http://docs.python-guide.org/en/latest/writing/documentation/
Publish: Figure out how to publish/host the docs appropriately. https://readthedocs.org/ seems to be commonly used, similar to http://rubydoc.info.
Examples: Like the Ruby nexpose-client repo, we should also provide example scripts that show how to accomplish some useful tasks. Users could then build upon those examples for real world use.
Verify: Make sure all source-based docs are suitable for use with doc tools. A probably useful reference: http://docs.python-guide.org/en/latest/writing/documentation/
Publish: Figure out how to publish/host the docs appropriately. https://readthedocs.org/ seems to be commonly used, similar to http://rubydoc.info.
Examples: Like the Ruby nexpose-client repo, we should also provide example scripts that show how to accomplish some useful tasks. Users could then build upon those examples for real world use.