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

Continuous integration should break when doctests are broken #345

Open
scls19fr opened this issue Nov 12, 2017 · 7 comments
Open

Continuous integration should break when doctests are broken #345

scls19fr opened this issue Nov 12, 2017 · 7 comments

Comments

@scls19fr
Copy link
Member

Hello,

I did a (voluntary) mistake in https://github.com/JuliaCollections/DataStructures.jl/pull/344/files#diff-dc614dd5c3fe25430697f06e62e01395R344

But Travis shows a green badge
https://travis-ci.org/JuliaCollections/DataStructures.jl/jobs/301055719

I think, continuous integration should break when doctests are broken

Kind regards

@oxinabox
Copy link
Member

To do it we'ld need to add Documentor.jl to the Requires (right?).
Which I think is Ok.
So this just needs to be done

@scls19fr
Copy link
Member Author

I don't think adding Documentor to REQUIRE is enough.
I don't even know if that's necessary as Sphinx is used for building documentation

@oxinabox
Copy link
Member

oxinabox commented Nov 13, 2017

What i mean to say is we'ld need to migrate from Sphinx to Documentor.jl.
I assume Sphinx can't run julia doctests

@scls19fr
Copy link
Member Author

Ok so that's a separate issue

@kmsquire
Copy link
Member

What i mean to say is we'ld need to migrate from Sphinx to Documentor.jl.

Commented in #343 before I saw this, (and just saw #346), but yes, this is what is needed.

@scls19fr
Copy link
Member Author

scls19fr commented Jan 5, 2018

Related Documenter issue JuliaDocs/Documenter.jl#527

@scls19fr
Copy link
Member Author

Looks quite similar than JuliaReach/LazySets.jl#71 which was addressed using JuliaReach/LazySets.jl#467

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