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

Do not run all the doctests in build_doc #2422

Closed
thofma opened this issue May 27, 2023 · 4 comments
Closed

Do not run all the doctests in build_doc #2422

thofma opened this issue May 27, 2023 · 4 comments

Comments

@thofma
Copy link
Collaborator

thofma commented May 27, 2023

At the moment , Oscar.build_doc calls makedocs(...) with all our upstream packages. I think this is necessary, so that all docstrings are picked up properly. But this has the big disadvantage, that doctests for all upstream packages are run. This is quite a waste of time and also leads to errors, if run with :fix and something unrelated is broken in a dependency. And it is also not what we do test with CI. I propose to replace

doctest=doctest,

by a separate manual Documenter.doctest(Oscar; doctest = doctest) call.

Any objections @fingolfin @benlorenz? Or something that I am missing?

@fingolfin
Copy link
Member

Makes sense to me

@lgoettgens
Copy link
Member

This has been fixed by #2423.

@fingolfin
Copy link
Member

We now have doctest_fix. I am not sure if there is anything left to be done, @thofma ?

@thofma
Copy link
Collaborator Author

thofma commented Jul 5, 2023

It was already fixed in #2423.

@thofma thofma closed this as completed Jul 5, 2023
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

No branches or pull requests

3 participants