Skip to content

Commit

Permalink
Docs format update
Browse files Browse the repository at this point in the history
  • Loading branch information
RealPolitiX committed Oct 28, 2020
1 parent d314388 commit 62452b9
Show file tree
Hide file tree
Showing 23 changed files with 220 additions and 16 deletions.
Binary file modified docs/doctrees/02_general_parameters.doctree
Binary file not shown.
Binary file modified docs/doctrees/03_entry_specific_parameters.doctree
Binary file not shown.
Binary file modified docs/doctrees/04_user_parameters.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
26 changes: 25 additions & 1 deletion docs/html/02_general_parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Entry specific parameters" href="03_entry_specific_parameters.html" />
<link rel="prev" title="Introduction" href="01_introduction.html" />
<link rel="stylesheet" href="../../_static/blockquote.css" type="text/css" />

</head><body>
Expand All @@ -28,6 +30,12 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="03_entry_specific_parameters.html" title="Entry specific parameters"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="01_introduction.html" title="Introduction"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">General parameters</a></li>
</ul>
Expand All @@ -40,6 +48,10 @@ <h3>Navigation</h3>

<div class="section" id="general-parameters">
<h1>General parameters<a class="headerlink" href="#general-parameters" title="Permalink to this headline"></a></h1>
<dl class="simple">
<dt><strong>Status</strong>:</dt><dd><p>something something</p>
</dd>
</dl>
</div>


Expand All @@ -49,6 +61,12 @@ <h1>General parameters<a class="headerlink" href="#general-parameters" title="Pe
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="01_introduction.html"
title="previous chapter">Introduction</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="03_entry_specific_parameters.html"
title="next chapter">Entry specific parameters</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -100,6 +118,12 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="03_entry_specific_parameters.html" title="Entry specific parameters"
>next</a> |</li>
<li class="right" >
<a href="01_introduction.html" title="Introduction"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">General parameters</a></li>
</ul>
Expand Down
24 changes: 23 additions & 1 deletion docs/html/03_entry_specific_parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="User parameters" href="04_user_parameters.html" />
<link rel="prev" title="General parameters" href="02_general_parameters.html" />
<link rel="stylesheet" href="../../_static/blockquote.css" type="text/css" />

</head><body>
Expand All @@ -28,6 +30,12 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="04_user_parameters.html" title="User parameters"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="02_general_parameters.html" title="General parameters"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Entry specific parameters</a></li>
</ul>
Expand All @@ -40,6 +48,8 @@ <h3>Navigation</h3>

<div class="section" id="entry-specific-parameters">
<h1>Entry specific parameters<a class="headerlink" href="#entry-specific-parameters" title="Permalink to this headline"></a></h1>
<p>An entry is meant to be relative to a single “measurement” i.e. it contains data and metadata relative to an acquisition of a specific observable.</p>
<p>Some of the parameters in the original list are present in the NeXus hierarchy, but much deeper in the tree. If it is decided that these parameters are necessary at this point in the hierarchy, they could be still saved in positions following the NX standard, but cross-linked in a freeform general field called <code class="docutils literal notranslate"><span class="pre">NXentry:notes</span></code>.</p>
</div>


Expand All @@ -49,6 +59,12 @@ <h1>Entry specific parameters<a class="headerlink" href="#entry-specific-paramet
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="02_general_parameters.html"
title="previous chapter">General parameters</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="04_user_parameters.html"
title="next chapter">User parameters</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -100,6 +116,12 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="04_user_parameters.html" title="User parameters"
>next</a> |</li>
<li class="right" >
<a href="02_general_parameters.html" title="General parameters"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Entry specific parameters</a></li>
</ul>
Expand Down
13 changes: 12 additions & 1 deletion docs/html/04_user_parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Entry specific parameters" href="03_entry_specific_parameters.html" />
<link rel="stylesheet" href="../../_static/blockquote.css" type="text/css" />

</head><body>
Expand All @@ -28,6 +29,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="03_entry_specific_parameters.html" title="Entry specific parameters"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">User parameters</a></li>
</ul>
Expand All @@ -40,6 +44,7 @@ <h3>Navigation</h3>

<div class="section" id="user-parameters">
<h1>User parameters<a class="headerlink" href="#user-parameters" title="Permalink to this headline"></a></h1>
<p>Information about the user responsible for the entry is significant. It is also well organized in NeXus hierarchy.</p>
</div>


Expand All @@ -49,6 +54,9 @@ <h1>User parameters<a class="headerlink" href="#user-parameters" title="Permalin
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="03_entry_specific_parameters.html"
title="previous chapter">Entry specific parameters</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -100,6 +108,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="03_entry_specific_parameters.html" title="Entry specific parameters"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">User parameters</a></li>
</ul>
Expand Down
113 changes: 113 additions & 0 deletions docs/html/05_instrumentation_parameters.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@




<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Instrumentation parameters &#8212; mpes-nexus documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/blockquote.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="../../_static/blockquote.css" type="text/css" />

</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Instrumentation parameters</a></li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="instrumentation-parameters">
<h1>Instrumentation parameters<a class="headerlink" href="#instrumentation-parameters" title="Permalink to this headline"></a></h1>
<p>The class <code class="docutils literal notranslate"><span class="pre">NXinstrument</span></code> refers to the whole set-up (beamline, or apparatus in a lab), and the sub-components are defined within it as sub-groups.</p>
</div>


<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/05_instrumentation_parameters.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<div id="google_search" style="display: none">
<hr />
<h3>Google search</h3>
<form method="get" action="https://www.google.com/search">
<table border="0" align="center" cellpadding="0">
<tr>
<td>
<input type="text" name="q" value="" />
</td>
</tr>
<tr>
<td align="center" style="font-size:75%">
<input type="radio" name="sitesearch" value="" />global
<input type="radio" name="sitesearch"
value="manual.nexusformat.org"
checked />NeXus manual
<input type="submit" value="Go" />
<br />
</td>
</tr>
</table>
</form>
</div>
<script type="text/javascript">$('#google_search').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">mpes-nexus documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Instrumentation parameters</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2018-2020, Tommaso Pincelli, R. Patrick Xian, Maciej Dendzik, Laurenz Rettig, Ralph Ernstorfer.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
5 changes: 4 additions & 1 deletion docs/html/_sources/02_general_parameters.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
===================
General parameters
===================
===================

**Status**:
something something
7 changes: 6 additions & 1 deletion docs/html/_sources/03_entry_specific_parameters.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
==========================
Entry specific parameters
==========================
==========================


An entry is meant to be relative to a single “measurement” i.e. it contains data and metadata relative to an acquisition of a specific observable.

Some of the parameters in the original list are present in the NeXus hierarchy, but much deeper in the tree. If it is decided that these parameters are necessary at this point in the hierarchy, they could be still saved in positions following the NX standard, but cross-linked in a freeform general field called ``NXentry:notes``.
4 changes: 3 additions & 1 deletion docs/html/_sources/04_user_parameters.rst.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
================
User parameters
================
================

Information about the user responsible for the entry is significant. It is also well organized in NeXus hierarchy.
6 changes: 6 additions & 0 deletions docs/html/_sources/05_instrumentation_parameters.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
===========================
Instrumentation parameters
===========================


The class ``NXinstrument`` refers to the whole set-up (beamline, or apparatus in a lab), and the sub-components are defined within it as sub-groups.
3 changes: 2 additions & 1 deletion docs/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ Metadata definitions of NeXus format for multidimensional photoemission spectros
01_introduction.rst
02_general_parameters.rst
03_entry_specific_parameters.rst
04_user_parameters.rst
04_user_parameters.rst
05_instrumentation_parameters.rst
1 change: 1 addition & 0 deletions docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ <h1>MPES NeXus<a class="headerlink" href="#mpes-nexus" title="Permalink to this
<li class="toctree-l1"><a class="reference internal" href="02_general_parameters.html">General parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="03_entry_specific_parameters.html">Entry specific parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="04_user_parameters.html">User parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="05_instrumentation_parameters.html">Instrumentation parameters</a></li>
</ul>
</div>
</div>
Expand Down
7 changes: 3 additions & 4 deletions docs/html/objects.inv
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Project: mpes-nexus
# Version:
# The remainder of this file is compressed using zlib.
xڅ��
� ��}
_`᪫�GtQ FН����>P��s�1������;�#I���nDǭljl�8���$�$�6��>
"[��4S�e�U`A�����#����=5-p��|��#���`�Ɏf�ig@���\ϻ:1���d-���*v5�'u��{�96��<+�n�AU#�m�L��p�W0��O-�m��6j`��q�k�Sx?gO@o�Ə
xڅ��
� ��>�/Вt��J-�P�M�N�,����kj$�&�M�����ʨ��̈�������8
�maJ�/E;�C�J�PEK0�t�� 8���x�Q�'`��0�l���s𤷱���jPK����V (G�mT[ڋ�~K����h�O��݉���K�� �gz�����a�$qM� ���jT�|�to �����SK;S�mT�",:�u2�4�.��S
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion docs/source/02_general_parameters.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
===================
General parameters
===================
===================

**Status**:
something something
7 changes: 6 additions & 1 deletion docs/source/03_entry_specific_parameters.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
==========================
Entry specific parameters
==========================
==========================


An entry is meant to be relative to a single “measurement” i.e. it contains data and metadata relative to an acquisition of a specific observable.

Some of the parameters in the original list are present in the NeXus hierarchy, but much deeper in the tree. If it is decided that these parameters are necessary at this point in the hierarchy, they could be still saved in positions following the NX standard, but cross-linked in a freeform general field called ``NXentry:notes``.
4 changes: 3 additions & 1 deletion docs/source/04_user_parameters.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
================
User parameters
================
================

Information about the user responsible for the entry is significant. It is also well organized in NeXus hierarchy.
6 changes: 6 additions & 0 deletions docs/source/05_instrumentation_parameters.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
===========================
Instrumentation parameters
===========================


The class ``NXinstrument`` refers to the whole set-up (beamline, or apparatus in a lab), and the sub-components are defined within it as sub-groups.
Loading

0 comments on commit 62452b9

Please sign in to comment.