Developer documentation

This part of the byro documentation is for you if you want to improve byro or develop a plugin.

If you want to improve byro itself, please head to our contributor documentation.

If you want to work on byro’s code (no matter which part), you’ll want to start with the Development setup. It contains the contributing guidelines, an explanation on how to build a pull request, which style guidelines to follow, and an internal API documentation.

If you want to develop (or improve) a plugin, have a look at our plugin development guides: They show how to develop a byro plugin with some hopefully easy-to-follow example plugins.

If any part of the documentation is unclear, please head over to the documentation setup to learn how to improve it, and then follow the contributor documentation to create a pull request.

Contents:

• Development setup
  • Get a copy of the source code
  • Your local python environment
  • Working with the code
• Contributing
• Patching documentation
  • Writing documentation
  • Translating documentation
  • Checking documentation
• Plugin Development
  • Creating a plugin
  • Signal list
  • Plugin: Custom member data