deploy: c50e83c

int-brain-lab · Dec 3, 2024 · c427014 · c427014
commit c427014
Show file tree

Hide file tree

Showing 105 changed files with 9,520 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: e9acee48e080261ecb115f5f22dfe399
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/api/iblqt.core.ColoredDataFrameTableModel.doctree b/.doctrees/api/iblqt.core.ColoredDataFrameTableModel.doctree
diff --git a/.doctrees/api/iblqt.core.DataFrameTableModel.doctree b/.doctrees/api/iblqt.core.DataFrameTableModel.doctree
diff --git a/.doctrees/api/iblqt.core.PathWatcher.doctree b/.doctrees/api/iblqt.core.PathWatcher.doctree
diff --git a/.doctrees/api/iblqt.core.doctree b/.doctrees/api/iblqt.core.doctree
diff --git a/.doctrees/api/iblqt.doctree b/.doctrees/api/iblqt.doctree
diff --git a/.doctrees/api/iblqt.widgets.CheckBoxDelegate.doctree b/.doctrees/api/iblqt.widgets.CheckBoxDelegate.doctree
diff --git a/.doctrees/api/iblqt.widgets.StatefulButton.doctree b/.doctrees/api/iblqt.widgets.StatefulButton.doctree
diff --git a/.doctrees/api/iblqt.widgets.doctree b/.doctrees/api/iblqt.widgets.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/dev_guide.doctree b/.doctrees/dev_guide.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/iblqt/core.html b/_modules/iblqt/core.html
diff --git a/_modules/iblqt/widgets.html b/_modules/iblqt/widgets.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,110 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; iblqt 0.3.1 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
+
+
+      <script src="../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../_static/documentation_options.js?v=4621528c"></script>
+      <script src="../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            iblqt
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Links</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference external" href="https://github.com/int-brain-lab/iblqt">GitHub</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/iblqt">PyPI</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">iblqt</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="PyQt5/QtCore.html">PyQt5.QtCore</a></li>
+<li><a href="iblqt/core.html">iblqt.core</a></li>
+<li><a href="iblqt/widgets.html">iblqt.widgets</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, International Brain Laboratory.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,9 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: api
+   :template: custom-module-template.rst
+   :recursive:
+
+   iblqt
diff --git a/_sources/api/iblqt.core.ColoredDataFrameTableModel.rst.txt b/_sources/api/iblqt.core.ColoredDataFrameTableModel.rst.txt
@@ -0,0 +1,9 @@
+iblqt.core.ColoredDataFrameTableModel
+=====================================
+
+.. currentmodule:: iblqt.core
+
+.. autoclass:: ColoredDataFrameTableModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.core.DataFrameTableModel.rst.txt b/_sources/api/iblqt.core.DataFrameTableModel.rst.txt
@@ -0,0 +1,9 @@
+iblqt.core.DataFrameTableModel
+==============================
+
+.. currentmodule:: iblqt.core
+
+.. autoclass:: DataFrameTableModel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.core.PathWatcher.rst.txt b/_sources/api/iblqt.core.PathWatcher.rst.txt
@@ -0,0 +1,9 @@
+iblqt.core.PathWatcher
+======================
+
+.. currentmodule:: iblqt.core
+
+.. autoclass:: PathWatcher
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.core.rst.txt b/_sources/api/iblqt.core.rst.txt
@@ -0,0 +1,16 @@
+iblqt.core
+==========
+
+.. automodule:: iblqt.core
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :nosignatures:
+      :toctree:
+      :template: custom-class-template.rst
+
+      ColoredDataFrameTableModel
+      DataFrameTableModel
+      PathWatcher
+
diff --git a/_sources/api/iblqt.rst.txt b/_sources/api/iblqt.rst.txt
@@ -0,0 +1,15 @@
+iblqt
+=====
+
+.. automodule:: iblqt
+
+.. rubric:: Modules
+
+.. autosummary::
+   :nosignatures:
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+
+   core
+   widgets
diff --git a/_sources/api/iblqt.widgets.CheckBoxDelegate.rst.txt b/_sources/api/iblqt.widgets.CheckBoxDelegate.rst.txt
@@ -0,0 +1,9 @@
+iblqt.widgets.CheckBoxDelegate
+==============================
+
+.. currentmodule:: iblqt.widgets
+
+.. autoclass:: CheckBoxDelegate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.widgets.StatefulButton.rst.txt b/_sources/api/iblqt.widgets.StatefulButton.rst.txt
@@ -0,0 +1,9 @@
+iblqt.widgets.StatefulButton
+============================
+
+.. currentmodule:: iblqt.widgets
+
+.. autoclass:: StatefulButton
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/api/iblqt.widgets.rst.txt b/_sources/api/iblqt.widgets.rst.txt
@@ -0,0 +1,15 @@
+iblqt.widgets
+=============
+
+.. automodule:: iblqt.widgets
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :nosignatures:
+      :toctree:
+      :template: custom-class-template.rst
+
+      CheckBoxDelegate
+      StatefulButton
+
diff --git a/_sources/changelog.rst.txt b/_sources/changelog.rst.txt
@@ -0,0 +1,2 @@
+.. include:: ../../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/_sources/dev_guide.rst.txt b/_sources/dev_guide.rst.txt
@@ -0,0 +1,58 @@
+Developer Guide
+===============
+
+PDM
+---
+
+This project is utilizing `PDM <https://pdm-project.org/>`_ as its package manager for managing dependencies and ensuring consistent and reproducible environments.
+See `PDM's documentation <https://pdm-project.org/en/latest/#recommended-installation-method>`_ for details on installing PDM.
+
+
+Installing developer dependencies
+---------------------------------
+
+.. code-block:: bash
+
+   pdm sync -d
+
+
+Running the unit-tests
+----------------------
+
+.. code-block:: bash
+
+   pdm run pytest
+
+
+Coverage report
+---------------
+
+.. code-block:: bash
+
+   pdm run coverage report
+
+
+Checking and formatting of code
+-------------------------------
+
+.. code-block:: bash
+
+   pdm run ruff format
+   pdm run ruff check --fix
+   pdm run mypy --package iblqt $(qtpy mypy-args)
+
+
+Building the documentation
+--------------------------
+
+.. code-block:: bash
+
+   pdm run sphinx-build ./docs/source ./docs/build
+
+
+Building the package
+--------------------
+
+.. code-block:: bash
+
+   pdm build
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,17 @@
+.. include:: ../../README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+   :caption: Contents
+   :hidden:
+
+   dev_guide
+   api
+   changelog
+
+.. toctree::
+   :caption: Links
+   :hidden:
+
+   GitHub <https://github.com/int-brain-lab/iblqt>
+   PyPI <https://pypi.org/project/iblqt>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		.. include:: ../../CHANGELOG.md
		:parser: myst_parser.sphinx_