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

Run doctests when building docs #203

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

schillic
Copy link
Member

@schillic schillic commented Nov 24, 2024

This PR is undoing #100.

I am actually not convinced that this is a good idea. But I would like to discuss what the right way is in general (run doctests with the docs or with the normal tests). Currently, we only run the doctests with the normal tests here and in ReachabilityBase.

Consequences of this change

  • The docs run becomes much heavier, as it needs to build all optional packages (from 3 min to 6 min). (At least in this package; in other packages, we create code depending on whether these packages are loaded, so we need to load them anyway in the normal docs run).
  • The test run gets a bit lighter, as Documenter is not built anymore and the doctests are not checked (from 6 min to 6 min on Ubuntu and from 20 min to 14 min on Windows). The latter gain should be minimal, given that the test run has already built the optional packages and compiled the functions used in the doctests.
  • Code coverage is only measured in the test run. So if a doctest uses code that is not used in other tests, it would only count toward the coverage in the test run.

@schillic schillic marked this pull request as ready for review November 24, 2024 15:15
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