V1.11 rc

.github/workflows/main.yaml

@@ -1,40 +1,68 @@
 on: 
   push:
     branches:
-      - v1.9_RC
+      - master
+      - v1.11_RC
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
   doc_build_job:
     runs-on: ubuntu-latest
     # This project MUST be given permission to use the image blow. at
     # Package settings-> Manage action access of the project hosting the
     # package
+    # Your project MUST contain empty .nojekyll file. Github Pages will
+    # discard everything starting with '_' i.e. the stylefiles.
     container: 'ghcr.io/thesystemdevelopmentkit/thesdktestimage:latest'
-    name: Test the submodules and Update the thesdk_template
+    name: Build documentation
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-      - name: Test and update
-        run: ./CI-helpers/test_and_release.sh -c -b "v1.9_RC" -t ${{ secrets.THESYDEKICK_TOKEN }}
+        uses: actions/checkout@v4
+      - name: Documentation builder action
+        run:  cd doc && rm -rf build && make html && cd .. && touch ./doc/build/html/.nojekyll
+      - name: GIT commit and push documentation
+        env:
+              CI_COMMIT_MESSAGE: Continuous Integration documentation update
+              CI_COMMIT_AUTHOR: Continuous Integration
+        run: |
+          git config --global --add safe.directory /__w/inverter/inverter
+          git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
+          git config --global user.email "${GITHUB_ACTOR}@noreply.github.com"
+          git add doc/build/html \
+            && git commit -m "${{ env.CI_COMMIT_MESSAGE }}" \
+            && git push \
+            || echo "Nothing to update"
 
-## This is an example how to run a image pull if needed.
-#  image_pull:
-#    runs-on: ubuntu-latest
-#    name: Pull docker image
-#    steps:
-#      - name: Login to Github Packages
-#        uses: docker/login-action@v1
-#        with:
-#          registry: ghcr.io
-#          username: ${{ github.actor }}
-#          password: ${{ secrets.GITHUB_TOKEN}}
-#
-#      - name: Pull image
-#        uses: docker/login-action@v1
-#        with:
-#          registry: ghcr.io
-#          username: ${{ github.actor }}
-#          password: ${{ secrets.GITHUB_TOKEN}}
-#      - name: Pull Docker image
-#        run: docker pull 'ghcr.io/thesystemdevelopmentkit/thesdktestimage:latest'
+  pages_deploy:
+    needs: doc_build_job
+  # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Update
+        run: git checkout $(git rev-parse HEAD)
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './doc/build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
 

.gitignore

@@ -1,6 +1,6 @@
 Makefile
 **/__pycache__
-doc/build/*
+doc/build/doctrees/environment.pickle
 *.eps
 *.pdf
 *~

README

@@ -0,0 +1,12 @@
+# Documentation
+
+Default page, if exists, is https://TheSystemDevelopmentKit.github.io/inverter/
+
+The 'docs' directory is a symbolic link to doc/build/html for github CI documentation builds.
+
+Github documentation flow is defined in .github/workflows/main.yaml
+
+The file ./doc/build/html.nojekyll is mandatory for Gitlab pages to parse
+files and directories starting with '_'.
+
+

doc/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 9141f2e4c7a05c963723f7cdb0b9af1c
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/build/html/_sources/index.rst.txt

@@ -0,0 +1,17 @@
+.. rtl documentation master file, created by
+   sphinx-quickstart on Thu Aug 15 11:47:06 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+========
+Inverter
+========
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   sections
+
+   indices_and_tables
+

doc/build/html/_sources/indices_and_tables.rst.txt

@@ -0,0 +1,7 @@
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/build/html/_sources/sections.rst.txt

@@ -0,0 +1,16 @@
+.. inverter documentation master file.
+   You can adapt this file completely to your liking, 
+   but it should at least contain the root `toctree` directive.
+
+Inverter class
+==============
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+.. automodule:: inverter
+   :members:
+   :special-members: __init__
+   :undoc-members:
+

doc/build/html/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}