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

Fix non-doctest documentation tests #1950

Closed
3 tasks
blnicho opened this issue Apr 26, 2021 · 0 comments · Fixed by #3080
Closed
3 tasks

Fix non-doctest documentation tests #1950

blnicho opened this issue Apr 26, 2021 · 0 comments · Fixed by #3080
Labels
bug documentation testing_and_ci Any issues related to testing and/or continuous integration (e.g., github, travis, etc.)

Comments

@blnicho
Copy link
Member

blnicho commented Apr 26, 2021

Summary

Several of our online documentation pages include code snippets that are "literal included" from doc/OnlineDocs/tests. This directory has a test driver script, test_examples.py, which is meant to test these code snippets that aren't being tested using the standard Sphinx doctest infrastructure. However, it doesn't look like we're running these tests in any of our automated testing infrastructure. Furthermore, the test_examples.py script is a modified copy of the book test driver which was rewritten in #1914.

We need to:

  • Update test_examples.py following the changes in examples/pyomobook/test_book_examples.py
  • Get the tests passing again
  • Make sure the tests are being run on GitHub Actions

Information on your system

Pyomo version: main branch
Python version: all
Operating system: all
How Pyomo was installed (PyPI, conda, source): source
Solver (if applicable):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation testing_and_ci Any issues related to testing and/or continuous integration (e.g., github, travis, etc.)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant