Docs (#30)

I checked all of the file changes, and the changes in docs are the most up to date version that we want in main.
sandialabs · Jun 10, 2024 · b130e87 · b130e87
2 parents 173a465 + 80910c8
commit b130e87
Show file tree

Hide file tree

Showing 42 changed files with 165 additions and 146 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,8 @@
 __pycache__/
 *.py[cod]
 *$py.class
-
+*pycache*
+-r *pycache*
 # C extensions
 *.so
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,10 @@
 sphinx-rtd-theme
 myst_parser
+numpy
+matplotlib
+pyro4
+serpent
+tqdm
+scipy
+qick==0.2.160
+IPython
diff --git a/docs/source/_static/HAHN_ECHO.png b/docs/source/_static/HAHN_ECHO.png
diff --git a/docs/source/_static/ODMR.png b/docs/source/_static/ODMR.png
diff --git a/docs/source/_static/PL.png b/docs/source/_static/PL.png
diff --git a/docs/source/_static/RABI.png b/docs/source/_static/RABI.png
diff --git a/docs/source/_static/READOUT.png b/docs/source/_static/READOUT.png
diff --git a/docs/source/_static/Ramsey.png b/docs/source/_static/Ramsey.png
diff --git a/docs/source/_static/T1.png b/docs/source/_static/T1.png
diff --git a/docs/source/_static/qickdawg_forgithub.png b/docs/source/_static/qickdawg_forgithub.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -12,11 +12,12 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
+
 
 # -- Project information -----------------------------------------------------
 
-project = 'QICK-DAWG'
+project = 'qickdawg'
 copyright = '2024, Andy Mounce, Emmeline Riendeau'
 author = 'Andy Mounce'
 
@@ -42,23 +43,27 @@
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 autodoc_typehints = "none"
-autoautodoc_docstring_signature = True
+autodoc_docstring_signature = True
 autodoc_default_options = {'members': None}
 
+# myst_parser options
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
-html_logo = "_static/QD_logo-removebg-preview.png"
-html_theme_options = {
-    'logo-only': True,
-    'display_version': False,
-}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-
+html_static_path = ['_static']
+html_logo = "_static/qickdawg_forgithub.png"
+html_theme_options = {
+    'logo_only': True
+} 
diff --git a/docs/source/hardware/Readme.md b/docs/source/hardware/Readme.md
diff --git a/docs/source/programs/conf.py b/docs/source/programs/conf.py
@@ -12,11 +12,12 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
+
 
 # -- Project information -----------------------------------------------------
 
-project = 'qick-dawg'
+project = 'qickdawg'
 copyright = '2024, Andy Mounce, Emmeline Riendeau'
 author = 'Andy Mounce'
 
@@ -42,9 +43,15 @@
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 autodoc_typehints = "none"
-autoautodoc_docstring_signature = True
+autodoc_docstring_signature = True
 autodoc_default_options = {'members': None}
 
+# myst_parser options
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

diff --git a/graphics/PMOD.png b/graphics/PMOD.png
diff --git a/graphics/balun_surgery_2.PNG b/graphics/balun_surgery_2.PNG
diff --git a/installation/Readme.md b/installation/Readme.md
diff --git a/installation/graphics/balun_circuit.PNG b/installation/graphics/balun_circuit.PNG
diff --git a/installation/graphics/balun_circuit.PNG.png b/installation/graphics/balun_circuit.PNG.png
diff --git a/installation/graphics/balun_surgery_1.PNG b/installation/graphics/balun_surgery_1.PNG
diff --git a/installation/graphics/balun_surgery_2.PNG b/installation/graphics/balun_surgery_2.PNG
diff --git a/qickdawg/fitfunctions/__pycache__/__init__.cpython-311.pyc b/qickdawg/fitfunctions/__pycache__/__init__.cpython-311.pyc
diff --git a/qickdawg/fitfunctions/__pycache__/exponentialdecay.cpython-311.pyc b/qickdawg/fitfunctions/__pycache__/exponentialdecay.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/getreadoutwindow.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/getreadoutwindow.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/hahnechodelaysweep.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/hahnechodelaysweep.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/laseroff.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/laseroff.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/laseron.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/laseron.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/lockinodmr.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/lockinodmr.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/nvaverageprogram.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/nvaverageprogram.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/nvconfiguration.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/nvconfiguration.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/nvqicksweep.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/nvqicksweep.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/plintensity.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/plintensity.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/rabisweep.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/rabisweep.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/ramsey.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/ramsey.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/readoutwindow.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/readoutwindow.cpython-311.pyc
diff --git a/qickdawg/nvpulsing/__pycache__/t1delaysweep.cpython-311.pyc b/qickdawg/nvpulsing/__pycache__/t1delaysweep.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/absolute.cpython-311.pyc b/qickdawg/util/__pycache__/absolute.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/compresseddifference.cpython-311.pyc b/qickdawg/util/__pycache__/compresseddifference.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/cpmgxy8arb.cpython-311.pyc b/qickdawg/util/__pycache__/cpmgxy8arb.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/intexpscale.cpython-311.pyc b/qickdawg/util/__pycache__/intexpscale.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/itemattribute.cpython-311.pyc b/qickdawg/util/__pycache__/itemattribute.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/liveplot.cpython-311.pyc b/qickdawg/util/__pycache__/liveplot.cpython-311.pyc
diff --git a/qickdawg/util/__pycache__/startclient.cpython-311.pyc b/qickdawg/util/__pycache__/startclient.cpython-311.pyc