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

docs: Added new workflow which can deploy the documentation to GitHub Pages #76

Merged
merged 1 commit into from
Oct 28, 2023

Conversation

qthompso
Copy link
Contributor

@qthompso qthompso commented Oct 27, 2023

Proposed changes

Created a workflow that can upload and deploy the documentation of tm_devices to GitHub Pages.

Fixes #73

Types of changes

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Functionality update (non-breaking change which updates or changes existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
  • 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

@qthompso qthompso requested a review from a team as a code owner October 27, 2023 23:49
@CLAassistant
Copy link

CLAassistant commented Oct 27, 2023

CLA assistant check
All committers have signed the CLA.

@nfelt14 nfelt14 requested a review from a team October 27, 2023 23:49
@qthompso qthompso temporarily deployed to package-build October 27, 2023 23:49 — with GitHub Actions Inactive
@nfelt14 nfelt14 enabled auto-merge (squash) October 27, 2023 23:51
@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

Merging #76 (c61b928) into main (09e9e6e) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #76   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          168       168           
  Lines         3761      3761           
  Branches       644       644           
=========================================
  Hits          3761      3761           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@nfelt14 nfelt14 added documentation Improvements or additions to documentation ci/cd Improvements or additions to the CI/CD process labels Oct 28, 2023
@qthompso qthompso temporarily deployed to package-build October 28, 2023 02:06 — with GitHub Actions Inactive
@qthompso qthompso temporarily deployed to package-build October 28, 2023 02:49 — with GitHub Actions Inactive
… Pages

	new file:   .github/workflows/deploy-documentation.yml
	modified:   README.rst
	modified:   pyproject.toml

Signed-off-by: qthompso <[email protected]>
@qthompso qthompso temporarily deployed to package-build October 28, 2023 02:51 — with GitHub Actions Inactive
@qthompso qthompso temporarily deployed to package-build October 28, 2023 03:18 — with GitHub Actions Inactive
@nfelt14 nfelt14 merged commit 7ab18d3 into tektronix:main Oct 28, 2023
34 checks passed
@nfelt14 nfelt14 self-assigned this Nov 7, 2023
qthompso added a commit to qthompso/tm_devices that referenced this pull request Feb 15, 2024
qthompso added a commit to qthompso/tm_devices that referenced this pull request Feb 16, 2024
v12ganesh pushed a commit to v12ganesh/tm_devices that referenced this pull request Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd Improvements or additions to the CI/CD process documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG]: Documentation is unavailable
3 participants