Signal Generation Restructure and addition of high level methods

.github/workflows/create_temp_html.yml

@@ -0,0 +1,24 @@
+---
+name: Create Temp HTML
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+# Cancel running jobs for the same workflow and branch.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+# IMPORTANT: Any new jobs need to be added to the check-docs-passed job to ensure they correctly gate code changes
+jobs:
+  create-fake-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: upload-temp-artifact
+        uses: actions/upload-artifact@v3
+        if: ${{ !cancelled() }}
+        with:
+          name: artifact_docs
+          path: test3.zip

.github/workflows/upload_artifacts.yml

@@ -0,0 +1,42 @@
+---
+name: Upload Artifact
+on:
+  workflow_run:
+    branches: [main]
+    workflows: [Create Temp HTML]
+    types:
+      - completed
+# Cancel running jobs for the same workflow and branch.
+concurrency:
+  group: publish-docs
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }} && github.ref ==
+      'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - run: echo 'The Test docs workflow passed'
+      - name: download-artifact
+        uses: dawidd6/action-download-artifact@v2.28.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          run_id: ${{ github.event.workflow_run.id }}
+          workflow_conclusion: success
+          name: artifact_docs
+      - name: unzip-artifact
+        run: |
+          unzip test3.zip
+          rm -r docs_results/.results_docs/html/.doctrees
+      - name: upload-pages-artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs_results/.results_docs/html
+      - name: deploy-to-github-pages
+        uses: actions/deploy-pages@v2
+        id: deployment

.pre-commit-config.yaml

@@ -62,17 +62,15 @@ repos:
         args: [--number, --end-of-line, keep]
         additional_dependencies:
           - setuptools  # This is required since Python 3.12 no longer installs setuptools by default in virtual environments
-          - mdformat-myst
-          - mdformat-toc
-          - mdformat-frontmatter
+          - black==23.12.1  # This may need to be updated/removed in the future once ruff supports formatting python code blocks in markdown
           - mdformat-beautysh
           - mdformat-black
-          - black==23.12.1  # This may need to be updated/removed in the future once ruff supports formatting python code blocks in markdown
           - mdformat-config
           - mdformat-shfmt
           - mdformat-web
           - mdformat-gfm
-          - mdformat-footnote
+          - mdformat-myst
+          - mdformat-toc
 # Currently rstcheck doesn't work with the templates
 #  - repo: https://github.com/rstcheck/rstcheck
 #    rev: v6.1.2

CHANGELOG.md

@@ -32,6 +32,34 @@ Things to be included in the next release go here.
 
 ______________________________________________________________________
 
+## v2.0.0 (2024-02-12)
+
+### Merged Pull Requests
+
+- feat: AWG Generate Function and Waveform Constraints
+
+### Added
+
+- Added drivers for AWG and AFG channels
+- Added a property named `source_channel` in AWG's and AFG's.
+- Added drivers for internal AFG in TekScopes.
+- Added a property named `internal_afg` in TekScope.
+- Added implementation of `generate_function` for all AWG models.
+- Added two burst functions to SignalGeneratorMixin: one to set up burst and one to generate the burst by forcing trigger.
+  - NOTE: Only the AFG's and internal AFG have these functions implemented.
+- Added `OutputSignalPath` enum attribute in AWG's representing output signal path options.
+- Added two functions for loading waveform set files in the AWG70k's and AWG5200: one for loading a waveform set file and another for loading a specific waveform from a waveform set file.
+- Added `sample_waveform_set_file` attribute in AWG70k's and AWG5200 to define the default waveform set file.
+
+### Changed
+
+- Changed the term "signal source" to "signal generator".
+- Changed the function name of `generate_waveform` to `generate_function`.
+- Changed the `generate_function` function by removing burst functionality.
+- Updated AWG's such that the `family_base_class` is at the model level.
+
+______________________________________________________________________
+
 ## v1.2.1 (2024-02-27)
 
 ### Merged Pull Requests

docs/advanced/index.md

@@ -9,6 +9,7 @@ Advanced information about the `tm_devices` package.
 maxdepth: 2
 ---
 architecture.md
+signal_generators.md
 ```
 
 ## Advanced Usage and Examples