List of examples

These pages are referenced by relative links in README.md.

• Snippet of use in GitHub Actions
• This is Markdown file example1.md
  • Interactive Python session (doctest)
  • Source Code and terminal output
• This is Markdown file example2.md
  • Fenced code block expected output block pair.
  • Another fenced code block expected output block pair.
  • Here is a second fenced code block with no info string.
  • Here are two Python code blocks in a row and one output block at the end.
  • A fenced code block with yaml info string.
  • A fenced block with text info string
  • A doctest session
  • One more code plus expected output pair.
  • Another doctest session (skipped in test_example2.py)
• doc/test_example2.py
• This is Markdown file directive1.md
  • skip directive. No test case gets generated.
  • skip directive on an expected output block.
  • skip directive on Python session.
  • mark.skip directive with label directive.
  • mark.skipif directive.
  • label directive on a session.
• doc/directive1.md
• doc/directive1_report.txt
• doc/test_directive1.py
• This is Markdown file directive2.md
  • This will be marked as the setup code.
  • This test case shows the setup names are visible.
  • This test case modifies mylist.
  • This test case sees the modified mylist.
  • This will be marked as the teardown code.
• doc/directive2.md
• doc/directive2_report.txt
• doc/test_directive2.py
• This is Markdown file directive3.md
  • share-names and clear-names directives.
  • Share the names assigned here with later Python code blocks.
  • This test case shows the shared names are visible.
  • This test case modifies grades.
  • This test case sees the modified grades.
  • This test case shares another name.
  • Use clear-names directive to un-share.
• doc/directive3.md
• doc/directive3_report.txt
• doc/test_directive3.py
• This is file doc/my_markdown_file.md
• Examples of code and session blocks
  • An example with a blank line in the output
  • Interactive Python session requires <BLANKINE> in the expected output
  • Interactive Python session with doctest directive
  • Session with py as the fenced code block info_string
• This is Markdown file setup.md
  • This will be the setup code.
  • This test case shows the setup names are visible
  • This test case modifies mylist.
  • This test case sees the modified mylist.
  • This will be specified as the teardown code.
• doc/test_setup.py
• This is Markdown file setup_doctest.md
  • This will be the setup code.
  • This test case shows the setup names are visible
  • This test case modifies mylist.
  • The next test case sees the modified mylist.
  • The names created by the setup code are optionally visible to sessions.
  • This will be specified as the teardown code.
• doc/test_setup_doctest.py
• This is Markdown file mark_example.md
  • Fenced code block expected output block pair.
  • The code block has 2 directives:
  • A doctest session
• doc/mark_example.md
• doc/test_mark_example.py
• This is Markdown file inline_example.md
• doc/test_inline_example.py
• tests/project_test.py