Project Documentation

[DrLuke]

Documentation is important for new users to understand how a library is used. While the readme provides some good examples for getting started, some of the more advanced topics are not covered and require reading code to understand.

This is why I've started documentation with #92, which adds some basic documentation of the dispatcher, client and server modules. The documentations should be expanded to all the other modules with further PRs. The documentation is written with sphinx, which allows easy and free hosting on read the docs.

Here's a suggested list of actions needed to be taken after #92:

• Module documentation
  • [x] dispatcher.py
  • [ ] osc_bundle.py
  • [ ] osc_bundle_builder.py
  • [ ] osc_message.py
  • [ ] osc_message_builder.py
  • [ ] osc_packet.py
  • [x] osc_server.py
  • [x] udp_client.py
  • [ ] osc_types.py
  • [ ] ntp.py
• Examples
  • [x] async server
  • [x] simple server
  • [x] simple client
  • [ ] client
  • [x] dispatcher
  • [ ] osc bundles
  • [ ] osc messages