From ee183eb799acfd7ca79591d8e070f529dab2c467 Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 09:35:52 +0200 Subject: [PATCH 1/8] update requirements --- docs/requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index cab17d2..ee1efc9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,6 @@ # File: docs/requirements.txt # Defining the exact version will make sure things don't break -Sphinx==3.3.1 -sphinx-rtd-theme==0.5.1 -rinohtype==0.5.0 +sphinx-rtd-theme +rinohtype +myst_nb \ No newline at end of file From 534bb5c354367fe0bc18e7941c4e0a29c0c11164 Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 09:40:41 +0200 Subject: [PATCH 2/8] importlib version --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index ee1efc9..8254940 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,4 +3,5 @@ # Defining the exact version will make sure things don't break sphinx-rtd-theme rinohtype +importlib-metadata==3.4.0 myst_nb \ No newline at end of file From edcf240642e104970d6821369021f073111053ac Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 09:45:41 +0200 Subject: [PATCH 3/8] importlib versions --- docs/requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 8254940..5bede94 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,7 @@ # File: docs/requirements.txt # Defining the exact version will make sure things don't break -sphinx-rtd-theme -rinohtype +sphinx-rtd-theme==0.5.1 +rinohtype==0.5.0 importlib-metadata==3.4.0 -myst_nb \ No newline at end of file +myst-nb==0.11.1 \ No newline at end of file From 6472cce4c25d5885cdc6bc06e5f5a293651e6aa4 Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 09:52:49 +0200 Subject: [PATCH 4/8] importlib autobuild --- docs/requirements.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 5bede94..89d3aca 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,17 @@ # File: docs/requirements.txt # Defining the exact version will make sure things don't break +Sphinx==3.3.1 +sphinx-autobuild==2020.9.1 +sphinx-reload==0.2.0 sphinx-rtd-theme==0.5.1 +sphinx-togglebutton==0.2.3 +sphinxcontrib-applehelp==1.0.2 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==1.0.3 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-serializinghtml==1.1.4 rinohtype==0.5.0 importlib-metadata==3.4.0 myst-nb==0.11.1 \ No newline at end of file From ea27b72dcb4b09fb0000ef56f96a2a868d40d08a Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 10:10:21 +0200 Subject: [PATCH 5/8] mock imports --- README.rst | 6 +++--- docs/source/conf.py | 23 ++++++++++++++++++++++- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index a3cd199..a3b8eb2 100644 --- a/README.rst +++ b/README.rst @@ -6,11 +6,11 @@ Cait (Cryogenic Artificial Intelligence Tools) is a Python 3 software package fo of raw data from cryogenic dark matter experiments. It is tailored to the needs of the CRESST and COSINUS experiment, but applicable to other, similar data structures. -**Documentation:** Preview: https://adoring-hoover-f7972f.netlify.app/ +**Documentation:** https://cait.readthedocs.io/ -**Source Code:** https://git.cryocluster.org/fwagner/cait (for CRYOCLUSTER collaborations) +**Source Code:** https://github.com/fewagner/cait -**Bug Report:** https://git.cryocluster.org/fwagner/cait/-/issues (for CRYOCLUSTER collaborations) +**Bug Report:** https://github.com/fewagner/cait/issues Installation diff --git a/docs/source/conf.py b/docs/source/conf.py index 22a2f22..58d1223 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -41,6 +41,27 @@ "sphinx.ext.viewcode", ] +autodoc_mock_imports = ['setuptools>=47.1.1', + 'h5py', + 'pickle-mixin', + 'numpy', + 'matplotlib', + 'scipy', + 'numba', + 'sklearn', + 'uproot', + 'awkward1', + 'torch', + 'torchvision', + 'pytorch-lightning', + 'ipywidgets', + 'tqdm', + 'pandas', + 'plotly', + 'dash_html_components', + 'dash_core_components', + 'dash'] + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -76,4 +97,4 @@ "deflist", "dollarmath", "html_image", -] \ No newline at end of file +] From bdf89fec839efd117f784ff759b77bc28f14245d Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 10:17:55 +0200 Subject: [PATCH 6/8] magic mock imports --- docs/source/conf.py | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 58d1223..7a804a8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,6 +13,7 @@ import os import sys import sphinx_rtd_theme +from unittest.mock import MagicMock sys.path.insert(0, os.path.abspath('../..')) sys.setrecursionlimit(1500) @@ -24,7 +25,7 @@ author = 'Felix Wagner' # The full version, including alpha/beta/rc tags -release = '0.1.0' +release = '1.0.0' # -- General configuration --------------------------------------------------- @@ -41,26 +42,26 @@ "sphinx.ext.viewcode", ] -autodoc_mock_imports = ['setuptools>=47.1.1', - 'h5py', - 'pickle-mixin', - 'numpy', - 'matplotlib', - 'scipy', - 'numba', - 'sklearn', - 'uproot', - 'awkward1', - 'torch', - 'torchvision', - 'pytorch-lightning', - 'ipywidgets', - 'tqdm', - 'pandas', - 'plotly', - 'dash_html_components', - 'dash_core_components', - 'dash'] +sys.modules['setuptools>=47.1.1'] = MagicMock() +sys.modules['h5py'] = MagicMock() +sys.modules['pickle-mixin'] = MagicMock() +sys.modules['numpy'] = MagicMock() +sys.modules['matplotlib'] = MagicMock() +sys.modules['scipy'] = MagicMock() +sys.modules['numba'] = MagicMock() +sys.modules['sklearn'] = MagicMock() +sys.modules['uproot'] = MagicMock() +sys.modules['awkward1'] = MagicMock() +sys.modules['torch'] = MagicMock() +sys.modules['torchvision'] = MagicMock() +sys.modules['pytorch-lightning'] = MagicMock() +sys.modules['ipywidgets'] = MagicMock() +sys.modules['tqdm'] = MagicMock() +sys.modules['pandas'] = MagicMock() +sys.modules['plotly'] = MagicMock() +sys.modules['dash_html_components'] = MagicMock() +sys.modules['dash_core_components'] = MagicMock() +sys.modules['dash'] = MagicMock() # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] From 6d9e7a46032763d317eb464b12aea0b6889f6e45 Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 10:26:41 +0200 Subject: [PATCH 7/8] magic mock imports 2 --- docs/source/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7a804a8..5de16c3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,7 +42,6 @@ "sphinx.ext.viewcode", ] -sys.modules['setuptools>=47.1.1'] = MagicMock() sys.modules['h5py'] = MagicMock() sys.modules['pickle-mixin'] = MagicMock() sys.modules['numpy'] = MagicMock() @@ -51,11 +50,9 @@ sys.modules['numba'] = MagicMock() sys.modules['sklearn'] = MagicMock() sys.modules['uproot'] = MagicMock() -sys.modules['awkward1'] = MagicMock() sys.modules['torch'] = MagicMock() sys.modules['torchvision'] = MagicMock() sys.modules['pytorch-lightning'] = MagicMock() -sys.modules['ipywidgets'] = MagicMock() sys.modules['tqdm'] = MagicMock() sys.modules['pandas'] = MagicMock() sys.modules['plotly'] = MagicMock() From 7ddde63d1986e10e67a29cddb8aca06fe04a3878 Mon Sep 17 00:00:00 2001 From: Felix Wagner <40992404+fewagner@users.noreply.github.com> Date: Sun, 11 Jul 2021 10:33:34 +0200 Subject: [PATCH 8/8] requirements autodocs --- docs/requirements.txt | 22 +++++++++++++++++++++- docs/source/conf.py | 18 ------------------ 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 89d3aca..80c3291 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -14,4 +14,24 @@ sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.4 rinohtype==0.5.0 importlib-metadata==3.4.0 -myst-nb==0.11.1 \ No newline at end of file +myst-nb==0.11.1 +setuptools>=47.1.1 +h5py +pickle-mixin +numpy +matplotlib +scipy +numba +sklearn +uproot +awkward1 +torch +torchvision +pytorch-lightning +ipywidgets +tqdm +pandas +plotly +dash_html_components +dash_core_components +dash diff --git a/docs/source/conf.py b/docs/source/conf.py index 5de16c3..f04fd8f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,24 +42,6 @@ "sphinx.ext.viewcode", ] -sys.modules['h5py'] = MagicMock() -sys.modules['pickle-mixin'] = MagicMock() -sys.modules['numpy'] = MagicMock() -sys.modules['matplotlib'] = MagicMock() -sys.modules['scipy'] = MagicMock() -sys.modules['numba'] = MagicMock() -sys.modules['sklearn'] = MagicMock() -sys.modules['uproot'] = MagicMock() -sys.modules['torch'] = MagicMock() -sys.modules['torchvision'] = MagicMock() -sys.modules['pytorch-lightning'] = MagicMock() -sys.modules['tqdm'] = MagicMock() -sys.modules['pandas'] = MagicMock() -sys.modules['plotly'] = MagicMock() -sys.modules['dash_html_components'] = MagicMock() -sys.modules['dash_core_components'] = MagicMock() -sys.modules['dash'] = MagicMock() - # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']