search

JuliaCollections / DataStructures.jl

Julia implementation of Data structures
https://juliacollections.github.io/DataStructures.jl/latest/
MIT License
691 stars 246 forks source link

Continuous integration should break when doctests are broken #345

Open s-celles opened 6 years ago

s-celles commented 6 years ago

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 commented 6 years ago

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

s-celles commented 6 years ago

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 commented 6 years ago

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

s-celles commented 6 years ago

Ok so that's a separate issue

kmsquire commented 6 years ago

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.

s-celles commented 6 years ago

Related Documenter issue https://github.com/JuliaDocs/Documenter.jl/issues/527

s-celles commented 6 years ago

Looks quite similar than https://github.com/JuliaReach/LazySets.jl/issues/71 which was addressed using https://github.com/JuliaReach/LazySets.jl/pull/467