Developer Guide

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

• Developer install

Tutorials for getting up and running as a developer.

How-to Guides

• Contributing to the project
• Moving code from another repo
• Build the docs using sphinx
• Run the tests using pytest
• Decision Flowchart for Creating a New ophyd_async Device
• Run static analysis using mypy
• Run linting using pre-commit
• Update the tools
• Make a release
• Creating a new beamline
• Zocalo Interaction

Practical step-by-step guides for day-to-day dev tasks.

Explanations

• Architectural Decision Records

Explanations of how and why the architecture is why it is.

Reference

• General Coding Standards
• Device Standards

Technical reference material on standards in use.