Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update api template usage #216

Merged
merged 4 commits into from
May 16, 2024
Merged

Update api template usage #216

merged 4 commits into from
May 16, 2024

Conversation

nfelt14
Copy link
Collaborator

@nfelt14 nfelt14 commented May 15, 2024

Proposed changes

Switch to using the jinja templates that mkdocstrings-python is introducing.

Types of changes

What types of changes does your code introduce?
Put an x in the boxes that apply

  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@nfelt14 nfelt14 requested review from a team as code owners May 15, 2024 23:51
@nfelt14 nfelt14 temporarily deployed to package-build May 15, 2024 23:51 — with GitHub Actions Inactive
@nfelt14 nfelt14 enabled auto-merge (squash) May 15, 2024 23:52
Copy link

codecov bot commented May 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (27a0f4d) to head (b63056c).
Report is 53 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #216   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          150       150           
  Lines         4118      4118           
  Branches       643       643           
=========================================
  Hits          4118      4118           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nfelt14 nfelt14 temporarily deployed to package-build May 16, 2024 00:07 — with GitHub Actions Inactive
@nfelt14 nfelt14 disabled auto-merge May 16, 2024 14:09
@nfelt14

This comment was marked as resolved.

@nfelt14 nfelt14 temporarily deployed to package-build May 16, 2024 15:38 — with GitHub Actions Inactive
@nfelt14
Copy link
Collaborator Author

nfelt14 commented May 16, 2024

  • Update API docs to show modules on the subpackage page.

See the preview docs from this PR for the new style of summary page for a package/subpackage in the API docs.

@nfelt14 nfelt14 enabled auto-merge (squash) May 16, 2024 15:42
Copy link

github-actions bot commented May 16, 2024

Test Results (ubuntu)

path passed subtotal
tests/test_afgs.py 2 2
tests/test_alias_dict.py 1 1
tests/test_all_device_drivers.py 1 1
tests/test_alternative_connection_addresses.py 17 17
tests/test_awgs.py 1 1
tests/test_config_parser.py 34 34
tests/test_device_manager.py 18 18
tests/test_devices_legacy_tsp_ieee_cmds.py 3 3
tests/test_helpers.py 68 68
tests/test_ieee_scpi_cmds.py 1 1
tests/test_margin_testers.py 5 5
tests/test_pi_device.py 1 1
tests/test_psu.py 1 1
tests/test_rest_api_device.py 10 10
tests/test_scopes.py 6 6
tests/test_singleton.py 1 1
tests/test_smu.py 4 4
tests/test_ss.py 1 1
tests/test_tm_devices.py 4 4
TOTAL 179 179

Link to workflow run

Copy link

github-actions bot commented May 16, 2024

Test Results (macos)

path passed subtotal
tests/test_afgs.py 2 2
tests/test_alias_dict.py 1 1
tests/test_all_device_drivers.py 1 1
tests/test_alternative_connection_addresses.py 17 17
tests/test_awgs.py 1 1
tests/test_config_parser.py 34 34
tests/test_device_manager.py 18 18
tests/test_devices_legacy_tsp_ieee_cmds.py 3 3
tests/test_helpers.py 68 68
tests/test_ieee_scpi_cmds.py 1 1
tests/test_margin_testers.py 5 5
tests/test_pi_device.py 1 1
tests/test_psu.py 1 1
tests/test_rest_api_device.py 10 10
tests/test_scopes.py 6 6
tests/test_singleton.py 1 1
tests/test_smu.py 4 4
tests/test_ss.py 1 1
tests/test_tm_devices.py 4 4
TOTAL 179 179

Link to workflow run

Copy link

github-actions bot commented May 16, 2024

Test Results (windows)

path passed subtotal
tests\test_afgs.py 2 2
tests\test_alias_dict.py 1 1
tests\test_all_device_drivers.py 1 1
tests\test_alternative_connection_addresses.py 17 17
tests\test_awgs.py 1 1
tests\test_config_parser.py 34 34
tests\test_device_manager.py 18 18
tests\test_devices_legacy_tsp_ieee_cmds.py 3 3
tests\test_helpers.py 68 68
tests\test_ieee_scpi_cmds.py 1 1
tests\test_margin_testers.py 5 5
tests\test_pi_device.py 1 1
tests\test_psu.py 1 1
tests\test_rest_api_device.py 10 10
tests\test_scopes.py 6 6
tests\test_singleton.py 1 1
tests\test_smu.py 4 4
tests\test_ss.py 1 1
tests\test_tm_devices.py 4 4
TOTAL 179 179

Link to workflow run

@nfelt14 nfelt14 added the documentation Improvements or additions to documentation label May 16, 2024
@nfelt14 nfelt14 merged commit baadd3d into main May 16, 2024
47 checks passed
@nfelt14 nfelt14 deleted the nfelt14/update-api-template-usage branch May 16, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants