Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Oct 23, 2024
1 parent 2bc15a1 commit dcf2957
Show file tree
Hide file tree
Showing 112 changed files with 6,507 additions and 51,656 deletions.
Binary file removed sed/latest/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/index.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/misc/contributing.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/misc/contribution.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/misc/maintain.doctree
View file
Binary file not shown.
872 changes: 0 additions & 872 deletions sed/latest/.doctrees/nbsphinx/user_guide/1_binning_fake_data.ipynb
View file

This file was deleted.

Binary file removed sed/latest/.doctrees/nbsphinx/user_guide_1_binning_fake_data_13_0.png
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/nbsphinx/user_guide_1_binning_fake_data_8_0.png
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/api.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/binning.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/calibrator.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/config.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/core.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/dataset.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/dfops.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/diagnostic.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/io.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/loader.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/sed/metadata.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/user_guide/1_binning_fake_data.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/user_guide/config.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/user_guide/index.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/user_guide/installation.doctree
View file
Binary file not shown.
Binary file removed sed/latest/.doctrees/workflows/index.doctree
View file
Binary file not shown.
Binary file modified sed/latest/_images/tutorial_1_binning_fake_data_13_0.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified sed/latest/_images/tutorial_1_binning_fake_data_8_0.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
217 changes: 99 additions & 118 deletions sed/latest/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,49 +7,53 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; SED 0.1.10a7 documentation</title>
<title>Overview: module code &#8212; SED 0.2.1 documentation</title>



<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }

</style>
</noscript>

<link href="../_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />

<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=c345357d"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=158ece9d"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="https://unpkg.com/@jupyter-widgets/html-manager@^0.20.1/dist/embed-amd.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.15.4';
DOCUMENTATION_OPTIONS.theme_version = '0.16.0';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.1.10a7';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.2.1';
DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.2.1" />
</head>


Expand All @@ -65,36 +69,24 @@
<i class="fa-solid fa-arrow-up"></i>Back to top</button>


<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>

<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>

<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<dialog id="pst-search-dialog">

<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
</form>
</dialog>

<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
Expand Down Expand Up @@ -123,7 +115,7 @@



<p class="title logo__title">SED 0.1.10a7 documentation</p>
<p class="title logo__title">SED 0.2.1 documentation</p>

</a></div>

Expand All @@ -134,28 +126,24 @@
<div class="me-auto navbar-header-items__center">

<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
`);
</script></div>
</div></div>

<div class="navbar-item">
<nav>
Expand All @@ -175,6 +163,13 @@
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../advanced_topics/index.html">
Workflows
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../sed/api.html">
API
Expand All @@ -199,29 +194,21 @@
<div class="navbar-item navbar-persistent--container">


<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>


<div class="navbar-item">

<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>

<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
Expand All @@ -246,15 +233,11 @@

<div class="navbar-persistent--mobile">

<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>


Expand All @@ -271,7 +254,8 @@



<div class="bd-sidebar-primary bd-sidebar hide-on-wide">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">



Expand All @@ -283,28 +267,24 @@


<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
`);
</script></div>
</div></div>



Expand All @@ -327,6 +307,13 @@
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../advanced_topics/index.html">
Workflows
</a>
</li>


<li class="nav-item ">
<a class="nav-link nav-internal" href="../sed/api.html">
API
Expand All @@ -352,15 +339,11 @@

<div class="navbar-item">

<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>

<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
Expand Down Expand Up @@ -417,8 +400,6 @@

<div class="header-article-item">



<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">

Expand All @@ -427,7 +408,7 @@
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page">Overview:...</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Overview: module code</span></li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -498,8 +479,8 @@ <h1>All modules for which code is available</h1>
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
<script defer src="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
Expand Down Expand Up @@ -532,7 +513,7 @@ <h1>All modules for which code is available</h1>

<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.4.
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0.
</p></div>

</div>
Expand Down
Loading

0 comments on commit dcf2957

Please sign in to comment.