deploy: 34fae41

main/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 991eeec390d99368d054b943a03c3e11
+config: da4fd8afab3b2f7590ddb813a70848e1
 tags: 645f666f9bcd5a90fca523b33c5a78b7

main/_sources/explanations.md.txt

@@ -0,0 +1,10 @@
+# Explanations
+
+Explanations of how it works and why it works that way.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+explanations/*
+```

main/_sources/explanations/decisions.md.txt

@@ -0,0 +1,18 @@
+% This Source Code Form is subject to the terms of the Mozilla Public
+
+% License, v. 2.0. If a copy of the MPL was not distributed with this
+
+% file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# Architectural Decision Records
+
+We record major architectural decisions in Architecture Decision Records (ADRs),
+as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+Below is the list of our current ADRs.
+
+```{toctree}
+:glob: true
+:maxdepth: 1
+
+decisions/*
+```

main/_sources/explanations/decisions/0001-record-architecture-decisions.md.txt

@@ -0,0 +1,18 @@
+# 1. Record architecture decisions
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+## Consequences
+
+See Michael Nygard's article, linked above. To create new ADRs we will copy and
+paste from existing ones.

main/_sources/explanations/decisions/0002-switched-to-python-copier-template.md.txt

@@ -0,0 +1,28 @@
+# 2. Adopt python-copier-template for project structure
+
+## Status
+
+Accepted
+
+## Context
+
+We should use the following [python-copier-template](https://github.com/DiamondLightSource/python-copier-template).
+The template will ensure consistency in developer
+environments and package management.
+
+## Decision
+
+We have switched to using the template.
+
+## Consequences
+
+This module will use a fixed set of tools as developed in `python-copier-template`
+and can pull from this template to update the packaging to the latest techniques.
+
+As such, the developer environment may have changed, the following could be
+different:
+
+- linting
+- formatting
+- pip venv setup
+- CI/CD

main/_sources/genindex.md.txt

@@ -0,0 +1,3 @@
+# Index
+
+<!-- Placeholder that sphinx will replace with a generated index -->

main/_sources/how-to.md.txt

@@ -0,0 +1,10 @@
+# How-to Guides
+
+Practical step-by-step guides for the more experienced user.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+how-to/*
+```

main/_sources/how-to/contribute.md.txt

@@ -0,0 +1,2 @@
+```{include} ../../.github/CONTRIBUTING.md
+```

main/_sources/how-to/run-container.md.txt

@@ -0,0 +1,14 @@
+# Run in a container
+
+Pre-built containers with {\{repo_name}} and its dependencies already
+installed are available on [Github Container Registry](https://ghcr.io/DiamondLightSource/python-copier-template-example).
+
+## Starting the container
+
+To pull the container from github container registry and run:
+
+```
+$ docker run ghcr.io/DiamondLightSource/python-copier-template-example:main --version
+```
+
+To get a released version, use a numbered release instead of `main`.

main/_sources/index.md.txt

@@ -0,0 +1,56 @@
+---
+html_theme.sidebar_secondary.remove: true
+---
+
+```{include} ../README.md
+:end-before: <!-- README only content
+```
+
+
+How the documentation is structured
+-----------------------------------
+
+Documentation is split into [four categories](https://diataxis.fr), also accessible from links in the top bar.
+
+<!-- https://sphinx-design.readthedocs.io/en/latest/grids.html -->
+
+::::{grid} 2
+:gutter: 4
+
+:::{grid-item-card} {material-regular}`directions_walk;2em`
+```{toctree}
+:maxdepth: 2
+tutorials
+```
++++
+Tutorials for installation and typical usage. New users start here.
+:::
+
+:::{grid-item-card} {material-regular}`directions;2em`
+```{toctree}
+:maxdepth: 2
+how-to
+```
++++
+Practical step-by-step guides for the more experienced user.
+:::
+
+:::{grid-item-card} {material-regular}`info;2em`
+```{toctree}
+:maxdepth: 2
+explanations
+```
++++
+Explanations of how it works and why it works that way.
+:::
+
+:::{grid-item-card} {material-regular}`menu_book;2em`
+```{toctree}
+:maxdepth: 2
+reference
+```
++++
+Technical reference material including APIs and release notes.
+:::
+
+::::

main/_sources/reference.md.txt

@@ -0,0 +1,11 @@
+# Reference
+
+Technical reference material including APIs and release notes.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+reference/*
+genindex
+```

main/_sources/reference/api.md.txt

@@ -0,0 +1,17 @@
+# API
+
+```{eval-rst}
+.. automodule:: python_copier_template_example
+
+ ``python_copier_template_example``
+ -----------------------------------
+```
+
+This is the internal API reference for {\{package_name}}
+
+```{eval-rst}
+.. data:: python_copier_template_example.__version__
+ :type: str
+
+ Version number as calculated by https://github.com/pypa/setuptools_scm
+```

main/_sources/tutorials.md.txt

@@ -0,0 +1,10 @@
+# Tutorials
+
+Tutorials for installation and typical usage. New users start here.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+tutorials/*
+```

main/_sources/tutorials/installation.md.txt

@@ -0,0 +1,42 @@
+# Installation
+
+## Check your version of python
+
+You will need python 3.8 or later. You can check your version of python by
+typing into a terminal:
+
+```
+$ python3 --version
+```
+
+## Create a virtual environment
+
+It is recommended that you install into a “virtual environment” so this
+installation will not interfere with any existing Python software:
+
+```
+$ python3 -m venv /path/to/venv
+$ source /path/to/venv/bin/activate
+```
+
+## Installing the library
+
+You can now use `pip` to install the library and its dependencies:
+
+```
+$ python3 -m pip install 
+```
+
+If you require a feature that is not currently released you can also install
+from github:
+
+```
+$ python3 -m pip install git+https://github.com/DiamondLightSource/python-copier-template-example.git
+```
+
+The library should now be installed and the commandline interface on your path.
+You can check the version that has been installed by typing:
+
+```
+$ python-copier-template-example --version
+```

main/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
- VERSION: '0.1.dev23+g2771891',
+ VERSION: '0.1.dev25+g34fae41',
  LANGUAGE: 'en',
  COLLAPSE_INDEX: false,
  BUILDER: 'html',