Skip to content

Commit b107ce8

Browse files
deploy: fe41594
1 parent fbb4cb9 commit b107ce8

24 files changed

+43
-43
lines changed

main/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 14081373a7ec147e1b33cc58e8dbfb09
3+
config: 381f08675a1e6286a94025238b3f12bc
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
819 Bytes
Binary file not shown.

main/_api.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>API &#8212; daq-config-server 1.0.1.dev9+g101303c79 documentation</title>
11+
<title>API &#8212; daq-config-server 1.0.1.dev10+gfe41594a6 documentation</title>
1212

1313

1414

@@ -41,7 +41,7 @@
4141
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
4242
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4343

44-
<script src="_static/documentation_options.js?v=cc01e7e4"></script>
44+
<script src="_static/documentation_options.js?v=ecb85cce"></script>
4545
<script src="_static/doctools.js?v=9bcbadda"></script>
4646
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
4747
<script src="_static/clipboard.min.js?v=a7894cd8"></script>

main/_api/daq_config_server.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>daq_config_server &#8212; daq-config-server 1.0.1.dev9+g101303c79 documentation</title>
11+
<title>daq_config_server &#8212; daq-config-server 1.0.1.dev10+gfe41594a6 documentation</title>
1212

1313

1414

@@ -41,7 +41,7 @@
4141
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
4242
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4343

44-
<script src="../_static/documentation_options.js?v=cc01e7e4"></script>
44+
<script src="../_static/documentation_options.js?v=ecb85cce"></script>
4545
<script src="../_static/doctools.js?v=9bcbadda"></script>
4646
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
4747
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>

main/_sources/how-to/config-server-guide.md.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ By default, this will return the file's raw string output - which includes thing
2020
(file-converters)=
2121
# File converters
2222

23-
Converters can be used to turn a file into a standard format server-side, reducing the complexity of reading config files client-side. Converters can convert config files to a `dict` or `pydantic model`, and the same `pydantic model` can be reconstructed client-side by the `get_file_contents` method. Available converters exist [here](https://github.com/DiamondLightSource/daq-config-server/blob/main/converters._converters.py) - see if there's a suitable converter you can use before adding your own. [This dictionary](https://github.com/DiamondLightSource/daq-config-server/blob/main/converters._file_converter_map.py) maps files to converters. Add the path of your config file and a suitable converter to this dictionary and it will automatically be used by the config server when a request for that file is made.
23+
Converters can be used to turn a file into a standard format server-side, reducing the complexity of reading config files client-side. Converters can convert config files to a `dict` or pydantic model, and the same pydantic model can be reconstructed client-side by the `get_file_contents` method. Available converters and models exist [here](https://github.com/DiamondLightSource/daq-config-server/blob/main/src/daq_config_server/models/converters/), divided into modules based on the type of config they convert - see if there's a suitable converter you can use before adding your own. [This dictionary](https://github.com/DiamondLightSource/daq-config-server/blob/main/src/daq_config_server/models/converters/_file_converter_map.py) maps files to converters. Add the path of your config file and a suitable converter to this dictionary and it will automatically be used by the config server when a request for that file is made. Models should be added to this [`__init__.py`](https://github.com/DiamondLightSource/daq-config-server/blob/main/src/daq_config_server/models/__init__.py) so that they can be imported with `from daq_config_server.models import MyModel`.
2424

2525
A request for `str` or `bytes` will fetch the raw file with no conversion.
2626

main/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '1.0.1.dev9+g101303c79',
2+
VERSION: '1.0.1.dev10+gfe41594a6',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

main/explanations.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>Explanations &#8212; daq-config-server 1.0.1.dev9+g101303c79 documentation</title>
11+
<title>Explanations &#8212; daq-config-server 1.0.1.dev10+gfe41594a6 documentation</title>
1212

1313

1414

@@ -41,7 +41,7 @@
4141
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
4242
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4343

44-
<script src="_static/documentation_options.js?v=cc01e7e4"></script>
44+
<script src="_static/documentation_options.js?v=ecb85cce"></script>
4545
<script src="_static/doctools.js?v=9bcbadda"></script>
4646
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
4747
<script src="_static/clipboard.min.js?v=a7894cd8"></script>

main/explanations/decisions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>Architectural Decision Records &#8212; daq-config-server 1.0.1.dev9+g101303c79 documentation</title>
11+
<title>Architectural Decision Records &#8212; daq-config-server 1.0.1.dev10+gfe41594a6 documentation</title>
1212

1313

1414

@@ -41,7 +41,7 @@
4141
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
4242
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4343

44-
<script src="../_static/documentation_options.js?v=cc01e7e4"></script>
44+
<script src="../_static/documentation_options.js?v=ecb85cce"></script>
4545
<script src="../_static/doctools.js?v=9bcbadda"></script>
4646
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
4747
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>

main/explanations/decisions/0001-record-architecture-decisions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>1. Record architecture decisions &#8212; daq-config-server 1.0.1.dev9+g101303c79 documentation</title>
11+
<title>1. Record architecture decisions &#8212; daq-config-server 1.0.1.dev10+gfe41594a6 documentation</title>
1212

1313

1414

@@ -41,7 +41,7 @@
4141
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
4242
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4343

44-
<script src="../../_static/documentation_options.js?v=cc01e7e4"></script>
44+
<script src="../../_static/documentation_options.js?v=ecb85cce"></script>
4545
<script src="../../_static/doctools.js?v=9bcbadda"></script>
4646
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
4747
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

main/explanations/decisions/0002-switched-to-python-copier-template.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta charset="utf-8" />
99
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
1010

11-
<title>2. Adopt python-copier-template for project structure &#8212; daq-config-server 1.0.1.dev9+g101303c79 documentation</title>
11+
<title>2. Adopt python-copier-template for project structure &#8212; daq-config-server 1.0.1.dev10+gfe41594a6 documentation</title>
1212

1313

1414

@@ -41,7 +41,7 @@
4141
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
4242
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
4343

44-
<script src="../../_static/documentation_options.js?v=cc01e7e4"></script>
44+
<script src="../../_static/documentation_options.js?v=ecb85cce"></script>
4545
<script src="../../_static/doctools.js?v=9bcbadda"></script>
4646
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
4747
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>

0 commit comments

Comments
 (0)