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

DRAFT Render plots in Haddock documentation #61

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

HeinrichApfelmus
Copy link
Collaborator

🚧 DRAFT

This pull requests adds a separate package deltaq-examples and uses doctest to render the plots as .svg files that are included in the Haddock.

Todo

  • Conceptually, we use doctest as a preprocessor, not as a test-suite.
  • doctest crashes program coverage, need to disable it
  • Add generation of .svg files to CI. Using a checksum in the output will make sure that the generated files match the ones that are checked into the repository.

Comments

@HeinrichApfelmus HeinrichApfelmus self-assigned this Dec 8, 2024
@HeinrichApfelmus HeinrichApfelmus force-pushed the HeinrichApfelmus/example-plot-doctest branch from 187f6d0 to 1ae6fea Compare December 20, 2024 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant