Skip to content

Commit

Permalink
update docu
Browse files Browse the repository at this point in the history
  • Loading branch information
jkotan committed Jan 25, 2024
1 parent e87dcbb commit 87902f4
Show file tree
Hide file tree
Showing 23 changed files with 46 additions and 46 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -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: 7b6e199ec491aa8e5fa6f0474d8949dd
config: 1ad12331daee84a78ee770c3beb0404e
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>Overview: module code &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/CheckerThread.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.CheckerThread &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.CheckerThread &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/Converter.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.Converter &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.Converter &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/Describer.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.Describer &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.Describer &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions _modules/nxsrecconfig/DynamicComponent.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.DynamicComponent &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.DynamicComponent &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -160,7 +160,7 @@ <h1>Source code for nxsrecconfig.DynamicComponent</h1><div class="highlight"><pr
<span class="s2">&quot;NXinstrument/collection&quot;</span><span class="p">,</span>
<span class="n">defaulttype</span><span class="o">=</span><span class="s2">&quot;NX_CHAR&quot;</span><span class="p">,</span>
<span class="n">defaultuserpath</span><span class="o">=</span><span class="s2">&quot;/$var.entryname#&#39;scan&#39;$var.serialno:NXentry/&quot;</span>
<span class="s2">&quot;data:NXdata&quot;</span><span class="p">):</span>
<span class="s2">&quot;user_data:NXparameters&quot;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; constructor</span>

<span class="sd"> :param nexusconfig_device: configserver configuration server</span>
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/MacroServerPools.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.MacroServerPools &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.MacroServerPools &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions _modules/nxsrecconfig/NXSConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.NXSConfig &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.NXSConfig &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -1969,7 +1969,7 @@ <h1>Source code for nxsrecconfig.NXSConfig</h1><div class="highlight"><pre>
<span class="p">[</span><span class="n">tango</span><span class="o">.</span><span class="n">DevString</span><span class="p">,</span>
<span class="s2">&quot;default NeXus User Data path&quot;</span><span class="p">,</span>
<span class="p">[</span><span class="s2">&quot;/$var.entryname#&#39;scan&#39;$var.serialno:NXentry/&quot;</span>
<span class="s2">&quot;user_data:NXdata&quot;</span><span class="p">]],</span>
<span class="s2">&quot;user_data:NXparameters&quot;</span><span class="p">]],</span>
<span class="s1">&#39;DefaultNeXusType&#39;</span><span class="p">:</span>
<span class="p">[</span><span class="n">tango</span><span class="o">.</span><span class="n">DevString</span><span class="p">,</span>
<span class="s2">&quot;default dynamic component NeXus data type&quot;</span><span class="p">,</span>
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/ProfileManager.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.ProfileManager &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.ProfileManager &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/Selection.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.Selection &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.Selection &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/Selector.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.Selector &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.Selector &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions _modules/nxsrecconfig/Settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.Settings &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.Settings &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -207,7 +207,7 @@ <h1>Source code for nxsrecconfig.Settings</h1><div class="highlight"><pre>
<span class="c1">#: (:obj:`str`) default NeXus path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaultUserDataPath</span> <span class="o">=</span> <span class="n">defaultudatapath</span> <span class="ow">or</span> \
<span class="s2">&quot;/$var.entryname#&#39;scan&#39;$var.serialno:NXentry/&quot;</span> \
<span class="s2">&quot;user_data:NXdata&quot;</span>
<span class="s2">&quot;user_data:NXparameters&quot;</span>

<span class="c1">#: (:obj:`str`) default NeXus type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaultNeXusType</span> <span class="o">=</span> <span class="n">defaultnexustype</span> <span class="ow">or</span> <span class="s2">&quot;NX_CHAR&quot;</span>
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/StreamSet.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.StreamSet &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.StreamSet &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions _modules/nxsrecconfig/Utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nxsrecconfig.Utils &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>nxsrecconfig.Utils &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '3.38.0',
VERSION: '3.39.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>Index &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -35,7 +35,7 @@
</button>
<a class="navbar-brand" href="index.html">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to nxsrecconfig’s documentation! &#8212; NXSRecSelector 3.38.0 documentation</title>
<title>Welcome to nxsrecconfig’s documentation! &#8212; NXSRecSelector 3.39.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -36,7 +36,7 @@
</button>
<a class="navbar-brand" href="#">
NXSRecSelector</a>
<span class="navbar-text navbar-version pull-left"><b>3.38</b></span>
<span class="navbar-text navbar-version pull-left"><b>3.39</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down

0 comments on commit 87902f4

Please sign in to comment.