Release/3.4.0

.github/workflows/unit-tests.yml

@@ -12,10 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', '3.11']
-        exclude:
-          - os: ubuntu-latest
-            python-version: '3.6'
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     env:
       OS: ${{ matrix.os }}
@@ -25,25 +22,26 @@ jobs:
 
     steps:
 
-      - uses: actions/setup-python@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - run: python -m pip install --upgrade pip
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - run: python -m pip install .[test]
 
-      - run: python -m pytest ./tests/ --cov=ebmlite --cov-report=xml --flake8 -n auto
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: multi-file-stuff
-          path: |
-            ./tests/SSX46714-doesnot.IDE
-            ./tests/SSX46714-new.IDE
-            ./tests/ssx-1.xml
-            ./tests/ssx-2.xml
+      - run: python -m pytest ./tests/ --cov=ebmlite --cov-report=xml -n auto
+
+#      - uses: actions/upload-artifact@v4
+#        with:
+#          name: multi-file-stuff
+#          overwrite: true
+#          path: |
+#            ./tests/SSX46714-doesnot.IDE
+#            ./tests/SSX46714-new.IDE
+#            ./tests/ssx-1.xml
+#            ./tests/ssx-2.xml
 
       - uses: codecov/codecov-action@v3
         with:

.gitignore

@@ -23,3 +23,6 @@ venv?
 *.egg*
 
 .mypy_cache
+
+# Sphinx documentation
+docs/_build/

.readthedocs.yml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

README.md

@@ -1,4 +1,4 @@
-![example workflow](https://github.com/MideTechnology/ebmlite/actions/workflows/unit-tests.yml/badge.svg) [![codecov](https://codecov.io/gh/MideTechnology/ebmlite/branch/master/graph/badge.svg)](https://codecov.io/gh/MideTechnology/ebmlite) 
+[![PyPI Latest Release](https://img.shields.io/pypi/v/ebmlite.svg)](https://pypi.org/project/ebmlite/) ![example workflow](https://github.com/MideTechnology/ebmlite/actions/workflows/unit-tests.yml/badge.svg) [![codecov](https://codecov.io/gh/MideTechnology/ebmlite/branch/master/graph/badge.svg)](https://codecov.io/gh/MideTechnology/ebmlite) 
 
 
 

codecov.yml

@@ -1,4 +1,2 @@
 coverage:
-  range: 50..90
-ignore:
-  - "ebmlite/tools"
+  range: 50..90

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/endaq-style.css

@@ -0,0 +1,136 @@
+@charset "utf-8";
+/* CSS Document */
+
+@charset "utf-8";
+/* CSS Document */
+
+
+/*****************************************************************************
+  * Color
+  * 
+  * Colors are defined in rgb string way, "red, green, blue"
+  **/
+  --pst-color-primary: #f26722;
+  --pst-color-success: 40, 167, 69;
+  --pst-color-info: 0, 123, 255;  /*23, 162, 184;*/
+  --pst-color-warning: 255, 193, 7;
+  --pst-color-danger: 220, 53, 69;
+  --pst-color-text-base: 51, 51, 51;
+
+  --pst-color-h1: var(--pst-color-primary);
+  --pst-color-h2: var(--pst-color-primary);
+  --pst-color-h3: var(--pst-color-text-base);
+  --pst-color-h4: var(--pst-color-text-base);
+  --pst-color-h5: var(--pst-color-text-base);
+  --pst-color-h6: var(--pst-color-text-base);
+  --pst-color-paragraph: var(--pst-color-text-base);
+  --pst-color-link: 231, 112, 37;
+  --pst-color-link-hover: 227, 46, 0;
+  --pst-color-headerlink: 198, 15, 15;
+  --pst-color-headerlink-hover: 255, 255, 255;
+  --pst-color-preformatted-text: 34, 34, 34;
+  --pst-color-preformatted-background: 250, 250, 250;
+  --pst-color-inline-code: 156, 35, 233;
+
+  --pst-color-active-navigation: 231, 112, 37;
+  --pst-color-navbar-link: 77, 77, 77;
+  --pst-color-navbar-link-hover: var(--pst-color-active-navigation);
+  --pst-color-navbar-link-active: var(--pst-color-active-navigation);
+  --pst-color-sidebar-link: 77, 77, 77;
+  --pst-color-sidebar-link-hover: var(--pst-color-active-navigation);
+  --pst-color-sidebar-link-active: var(--pst-color-active-navigation);
+  --pst-color-sidebar-expander-background-hover: 244, 244, 244;
+  --pst-color-sidebar-caption: 77, 77, 77;
+  --pst-color-toc-link: 119, 117, 122;
+  --pst-color-toc-link-hover: var(--pst-color-active-navigation);
+  --pst-color-toc-link-active: var(--pst-color-active-navigation);
+
+
+cite {
+	    font-style: normal!important;
+}
+
+  /*****************************************************************************
+  * Icon
+  **/
+
+  /* font awesome icons*/
+  --pst-icon-check-circle: '\f058';
+  --pst-icon-info-circle: '\f05a';
+  --pst-icon-exclamation-triangle: '\f071';
+  --pst-icon-exclamation-circle: '\f06a';
+  --pst-icon-times-circle: '\f057';
+  --pst-icon-lightbulb: '\f0eb';
+
+
+.wy-side-nav-search {
+    display: block;
+    width: 300px;
+    padding: .809em;
+    margin-bottom: .809em;
+    z-index: 200;
+    background-color: #e77025;
+    text-align: center;
+    color: #fcfcfc;
+}
+
+ul.task-bullet > li:before {
+    content: "";
+    height: 2em;
+    width: 2em;
+    display: block;
+    float: left;
+    margin-left: -2em;
+    background-position: center;
+    background-repeat: no-repeat;
+    background-color: #e77025;
+    border-radius: 50%;
+    background-size: 100%;
+    background-image: url(https://info.endaq.com/hubfs/readthedocs/question_mark_noback.svg);
+}
+
+.bd-search {
+    background-color: f4eeea;
+}
+
+h1 {
+	font-weight: bold;
+  color: #f26722;
+}
+
+dl.field-list {
+    background-color: #f3f3f3;
+    padding: 7px;
+}
+
+--pst-color-link: #e77025;
+
+.sig-name {
+    color: #9c23e9;
+}
+
+.prev-next-area a p.prev-next-title {
+    color: #e77025;
+    font-weight: 600;
+    font-size: 1.1em;
+}
+
+span.sig-name.descname > span {
+    color: #9c23e9;
+}
+
+h1 > cite, h2 > cite {
+  font-style: normal;
+  color: #e77025;
+}
+
+ h2 > cite {
+	font-size: 32px;
+}
+
+a.headerlink {
+    color: #00a9a4;
+    font-size: .8em;
+    padding: 0 4px;
+    text-decoration: none;
+}