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.

Sign up for GitHub

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

Jump to bottom

[BUG]: Enable test_docs.py and doctests tox environment in test-docs.yml workflow #17

Closed
nfelt14 opened this issue Sep 11, 2024 · 0 comments · Fixed by #22
Closed

[BUG]: Enable test_docs.py and doctests tox environment in test-docs.yml workflow #17

nfelt14 opened this issue Sep 11, 2024 · 0 comments · Fixed by #22
Assignees
@nfelt14 @u625355
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@nfelt14
Copy link
Collaborator

nfelt14 commented Sep 11, 2024

Description of the bug

Currently there is no test for documentation that comprehensively checks builds and links in the documentation. See https://github.com/tektronix/tm_devices/blob/main/tests/test_docs.py for a good example of the test file.

Steps To Reproduce

Run tox -e doctests

Environment Information

No response

Additional Information

No response
@nfelt14 nfelt14 added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 11, 2024
@nfelt14 nfelt14 self-assigned this Sep 11, 2024
@u625355 u625355 mentioned this issue Sep 12, 2024
Merged
18 tasks
@u625355 u625355 self-assigned this Sep 12, 2024
@nfelt14 nfelt14 linked a pull request Sep 12, 2024 that will close this issue
test: enabled doctest in test-docs.yml #22
Merged
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nfelt14 nfelt14

@u625355 u625355

Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

test: enabled doctest in test-docs.yml
2 participants
@nfelt14 @u625355