search

cstjean / ScikitLearn.jl

Julia implementation of the scikit-learn API https://cstjean.github.io/ScikitLearn.jl/dev/
Other
546 stars 75 forks source link

replace lexicon.jl with documenter.jl for generating docs. #71

Open OkonSamuel opened 4 years ago

OkonSamuel commented 4 years ago

According to Lexicon.jl Documentation generation using Docile.jl and Lexicon.jl is being deprecated in Julia 0.4 and above in favour of Documenter.jl.

cstjean commented 4 years ago

Yes! The docs are very much in need of a refresh. In fact, the notebooks should be converted into either Weave.jl or Literate.jl

OkonSamuel commented 4 years ago

@cstjean. There is one issue in converting the notebooks to weave or Literate.jl.

OkonSamuel commented 4 years ago

my plan is to use those notebooks as input and weave them to markdown in the doc generation process into a folder. Then finally add them to documenter

cstjean commented 4 years ago

That sounds good, too. I've never worked with either weave or literate; I just heard that it was superior to notebooks for docs. Which makes some sense. It's certainly better for git tracking.

We could redo the plots in Plots.jl too. That's obviously significant work, but it might be good to introduce new users to it rather than matplotlib.

OkonSamuel commented 4 years ago

@cstjean. OK I guess I will work on that later. But for now can we tag a new release ??

cstjean commented 4 years ago

Sure! Feel free to tag whenever you judge it's appropriate.