diff --git a/.gitignore b/.gitignore index 208ec4c..89f62d4 100644 --- a/.gitignore +++ b/.gitignore @@ -26,4 +26,6 @@ venv venv37 .vscode/ .venv -.vscode/settings.json +.vscode/settings.json +_venv +docs/_build diff --git a/docs/Makefile b/docs/Makefile index 69fe55e..298ea9e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,8 +4,8 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -SOURCEDIR = source -BUILDDIR = build +SOURCEDIR = . +BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/conf.py b/docs/conf.py index a69d094..1e80eac 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,20 +15,22 @@ import os import sys +import fixate + sys.path.append( - os.path.join(os.path.dirname(__file__), '..', '..', 'src') + os.path.join(os.path.dirname(__file__), '..', 'src') ) # -- Project information ----------------------------------------------------- project = 'Fixate' -copyright = '2018, Clint Lawrence, Ryan Parry-Jones' +copyright = '2024, Clint Lawrence, Ryan Parry-Jones' author = 'Clint Lawrence' # The short X.Y version -version = '' +version = fixate.__version__ # The full version, including alpha/beta/rc tags -release = '' +release = fixate.__version__ # -- General configuration --------------------------------------------------- @@ -40,12 +42,17 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.autodoc' +extensions = [ + 'sphinx.ext.napoleon', + 'sphinx.ext.autodoc', + 'sphinx.ext.coverage', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # @@ -60,7 +67,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/fixate/fixate.config.rst b/docs/fixate/fixate.config.rst new file mode 100644 index 0000000..a00dcf4 --- /dev/null +++ b/docs/fixate/fixate.config.rst @@ -0,0 +1,18 @@ +fixate.config package +===================== + +.. automodule:: fixate.config + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.config.helper module +--------------------------- + +.. automodule:: fixate.config.helper + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.core.rst b/docs/fixate/fixate.core.rst new file mode 100644 index 0000000..25aea69 --- /dev/null +++ b/docs/fixate/fixate.core.rst @@ -0,0 +1,66 @@ +fixate.core package +=================== + +.. automodule:: fixate.core + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.core.checks module +------------------------- + +.. automodule:: fixate.core.checks + :members: + :undoc-members: + :show-inheritance: + +fixate.core.common module +------------------------- + +.. automodule:: fixate.core.common + :members: + :undoc-members: + :show-inheritance: + +fixate.core.config\_util module +------------------------------- + +.. automodule:: fixate.core.config_util + :members: + :undoc-members: + :show-inheritance: + +fixate.core.control module +-------------------------- + +.. automodule:: fixate.core.control + :members: + :undoc-members: + :show-inheritance: + +fixate.core.exceptions module +----------------------------- + +.. automodule:: fixate.core.exceptions + :members: + :undoc-members: + :show-inheritance: + +fixate.core.jig\_mapping module +------------------------------- + +.. automodule:: fixate.core.jig_mapping + :members: + :undoc-members: + :show-inheritance: + +fixate.core.ui module +--------------------- + +.. automodule:: fixate.core.ui + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.daq.rst b/docs/fixate/fixate.drivers.daq.rst new file mode 100644 index 0000000..29572e2 --- /dev/null +++ b/docs/fixate/fixate.drivers.daq.rst @@ -0,0 +1,18 @@ +fixate.drivers.daq package +========================== + +.. automodule:: fixate.drivers.daq + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.drivers.daq.daqmx module +------------------------------- + +.. automodule:: fixate.drivers.daq.daqmx + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.dmm.rst b/docs/fixate/fixate.drivers.dmm.rst new file mode 100644 index 0000000..b4eeb82 --- /dev/null +++ b/docs/fixate/fixate.drivers.dmm.rst @@ -0,0 +1,34 @@ +fixate.drivers.dmm package +========================== + +.. automodule:: fixate.drivers.dmm + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.drivers.dmm.fluke\_8846a module +-------------------------------------- + +.. automodule:: fixate.drivers.dmm.fluke_8846a + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.dmm.helper module +-------------------------------- + +.. automodule:: fixate.drivers.dmm.helper + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.dmm.keithley\_6500 module +---------------------------------------- + +.. automodule:: fixate.drivers.dmm.keithley_6500 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.dso.rst b/docs/fixate/fixate.drivers.dso.rst new file mode 100644 index 0000000..d3ec202 --- /dev/null +++ b/docs/fixate/fixate.drivers.dso.rst @@ -0,0 +1,26 @@ +fixate.drivers.dso package +========================== + +.. automodule:: fixate.drivers.dso + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.drivers.dso.agilent\_mso\_x module +----------------------------------------- + +.. automodule:: fixate.drivers.dso.agilent_mso_x + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.dso.helper module +-------------------------------- + +.. automodule:: fixate.drivers.dso.helper + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.funcgen.rst b/docs/fixate/fixate.drivers.funcgen.rst new file mode 100644 index 0000000..b5e1735 --- /dev/null +++ b/docs/fixate/fixate.drivers.funcgen.rst @@ -0,0 +1,34 @@ +fixate.drivers.funcgen package +============================== + +.. automodule:: fixate.drivers.funcgen + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.drivers.funcgen.helper module +------------------------------------ + +.. automodule:: fixate.drivers.funcgen.helper + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.funcgen.keysight\_33500b module +---------------------------------------------- + +.. automodule:: fixate.drivers.funcgen.keysight_33500b + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.funcgen.rigol\_dg1022 module +------------------------------------------- + +.. automodule:: fixate.drivers.funcgen.rigol_dg1022 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.lcr.rst b/docs/fixate/fixate.drivers.lcr.rst new file mode 100644 index 0000000..2c86880 --- /dev/null +++ b/docs/fixate/fixate.drivers.lcr.rst @@ -0,0 +1,26 @@ +fixate.drivers.lcr package +========================== + +.. automodule:: fixate.drivers.lcr + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.drivers.lcr.agilent\_u1732c module +----------------------------------------- + +.. automodule:: fixate.drivers.lcr.agilent_u1732c + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.lcr.helper module +-------------------------------- + +.. automodule:: fixate.drivers.lcr.helper + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.pps.rst b/docs/fixate/fixate.drivers.pps.rst new file mode 100644 index 0000000..7cbfebc --- /dev/null +++ b/docs/fixate/fixate.drivers.pps.rst @@ -0,0 +1,34 @@ +fixate.drivers.pps package +========================== + +.. automodule:: fixate.drivers.pps + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.drivers.pps.bk\_178x module +---------------------------------- + +.. automodule:: fixate.drivers.pps.bk_178x + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.pps.helper module +-------------------------------- + +.. automodule:: fixate.drivers.pps.helper + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.pps.siglent\_spd\_3303X module +--------------------------------------------- + +.. automodule:: fixate.drivers.pps.siglent_spd_3303X + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.drivers.rst b/docs/fixate/fixate.drivers.rst new file mode 100644 index 0000000..e342f4e --- /dev/null +++ b/docs/fixate/fixate.drivers.rst @@ -0,0 +1,39 @@ +fixate.drivers package +====================== + +.. automodule:: fixate.drivers + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + fixate.drivers.daq + fixate.drivers.dmm + fixate.drivers.dso + fixate.drivers.funcgen + fixate.drivers.lcr + fixate.drivers.pps + +Submodules +---------- + +fixate.drivers.ftdi module +-------------------------- + +.. automodule:: fixate.drivers.ftdi + :members: + :undoc-members: + :show-inheritance: + +fixate.drivers.handlers module +------------------------------ + +.. automodule:: fixate.drivers.handlers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.examples.rst b/docs/fixate/fixate.examples.rst new file mode 100644 index 0000000..390d8da --- /dev/null +++ b/docs/fixate/fixate.examples.rst @@ -0,0 +1,74 @@ +fixate.examples package +======================= + +.. automodule:: fixate.examples + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.examples.function\_generator module +------------------------------------------ + +.. automodule:: fixate.examples.function_generator + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.jig\_driver module +---------------------------------- + +.. automodule:: fixate.examples.jig_driver + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.multi\_level\_design module +------------------------------------------- + +.. automodule:: fixate.examples.multi_level_design + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.programmable\_power\_supply module +-------------------------------------------------- + +.. automodule:: fixate.examples.programmable_power_supply + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.test\_script module +----------------------------------- + +.. automodule:: fixate.examples.test_script + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.tiny module +--------------------------- + +.. automodule:: fixate.examples.tiny + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.tiny\_images module +----------------------------------- + +.. automodule:: fixate.examples.tiny_images + :members: + :undoc-members: + :show-inheritance: + +fixate.examples.tiny\_variants module +------------------------------------- + +.. automodule:: fixate.examples.tiny_variants + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.reporting.rst b/docs/fixate/fixate.reporting.rst new file mode 100644 index 0000000..d9a7fa4 --- /dev/null +++ b/docs/fixate/fixate.reporting.rst @@ -0,0 +1,18 @@ +fixate.reporting package +======================== + +.. automodule:: fixate.reporting + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.reporting.csv module +--------------------------- + +.. automodule:: fixate.reporting.csv + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.rst b/docs/fixate/fixate.rst new file mode 100644 index 0000000..c4faea0 --- /dev/null +++ b/docs/fixate/fixate.rst @@ -0,0 +1,32 @@ +fixate package +============== + +.. automodule:: fixate + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + fixate.config + fixate.core + fixate.drivers + fixate.examples + fixate.reporting + fixate.ui_cmdline + fixate.ui_gui_qt + +Submodules +---------- + +fixate.sequencer module +----------------------- + +.. automodule:: fixate.sequencer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.ui_cmdline.rst b/docs/fixate/fixate.ui_cmdline.rst new file mode 100644 index 0000000..eb13b85 --- /dev/null +++ b/docs/fixate/fixate.ui_cmdline.rst @@ -0,0 +1,26 @@ +fixate.ui\_cmdline package +========================== + +.. automodule:: fixate.ui_cmdline + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.ui\_cmdline.cmd\_line module +----------------------------------- + +.. automodule:: fixate.ui_cmdline.cmd_line + :members: + :undoc-members: + :show-inheritance: + +fixate.ui\_cmdline.kbhit module +------------------------------- + +.. automodule:: fixate.ui_cmdline.kbhit + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fixate/fixate.ui_gui_qt.rst b/docs/fixate/fixate.ui_gui_qt.rst new file mode 100644 index 0000000..21fea6a --- /dev/null +++ b/docs/fixate/fixate.ui_gui_qt.rst @@ -0,0 +1,34 @@ +fixate.ui\_gui\_qt package +========================== + +.. automodule:: fixate.ui_gui_qt + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +fixate.ui\_gui\_qt.layout module +-------------------------------- + +.. automodule:: fixate.ui_gui_qt.layout + :members: + :undoc-members: + :show-inheritance: + +fixate.ui\_gui\_qt.subclassed\_widgets module +--------------------------------------------- + +.. automodule:: fixate.ui_gui_qt.subclassed_widgets + :members: + :undoc-members: + :show-inheritance: + +fixate.ui\_gui\_qt.ui\_gui\_qt module +------------------------------------- + +.. automodule:: fixate.ui_gui_qt.ui_gui_qt + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 47ece75..341f378 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,8 +18,24 @@ Whether you are trying to help do complete repetitive tests on your workbench to quickstart example_walkthrough + fixate/fixate release-notes +.. comment .. + Fixate API docs generated with: + sphinx-apidoc -o fixate --no-toc --remove-old --module-first ../src/fixate + https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html + So all the files in the fixate directory are autogenerated, but we may want to tweak them + or move them to this parent directory once we understand what's being generated + + useful args: + --module-first: since the modules have the more useful stuff? + --no-toc: don't generate modules.rst since it's a full package + --remove-old: since we have source control, just delete superseded files + + # TODO: do we autogen the API RST on every docs build? would be better to capture any changes + + Indices and tables ================== diff --git a/docs/make.bat b/docs/make.bat index 4d9eb83..32810c4 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,10 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help +set SOURCEDIR=. +set BUILDDIR=_build %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( @@ -25,11 +23,13 @@ if errorlevel 9009 ( exit /b 1 ) -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end :help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% :end popd