python_copier_template_example

An expanded https://github.com/DiamondLightSource/python-copier-template to illustrate how it looks with all the options enabled.

This is where you should write a short paragraph that describes what your module does, how it does it, and why people should use it.

Source	DiamondLightSource/python-copier-template-example
PyPI	pip install dls-python-copier-template-example
Docker	docker run ghcr.io/diamondlightsource/python-copier-template-example:latest
Documentation	https://diamondlightsource.github.io/python-copier-template-example
Releases	DiamondLightSource/python-copier-template-example

This is where you should put some images or code snippets that illustrate some relevant examples. If it is a library then you might put some introductory code here:

from python_copier_template_example import __version__

print(f"Hello python_copier_template_example {__version__}")

Or if it is a commandline tool then you might put some example commands here:

python -m python_copier_template_example --version

How the documentation is structured

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

• Tutorials
  • Installation

Tutorials for installation and typical usage. New users start here.

• How-to Guides
  • Contribute to the project
  • Run in a container

Practical step-by-step guides for the more experienced user.

• Explanations
  • Architectural Decision Records

Explanations of how it works and why it works that way.

• Reference
  • API
  • Index
  • Release Notes

Technical reference material including APIs and release notes.