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

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

Open
OkonSamuel opened this issue Mar 28, 2020 · 6 comments
Open

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

OkonSamuel opened this issue Mar 28, 2020 · 6 comments
Assignees

Comments

@OkonSamuel
Copy link
Collaborator

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
Copy link
Owner

cstjean commented Apr 1, 2020

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 OkonSamuel self-assigned this Apr 3, 2020
@OkonSamuel
Copy link
Collaborator Author

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

  • weave only supports Plots.jl plots
  • Literate doesn't yet support capturing plots

@OkonSamuel
Copy link
Collaborator Author

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
Copy link
Owner

cstjean commented Jun 3, 2020

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
Copy link
Collaborator Author

OkonSamuel commented Jun 4, 2020

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

@cstjean
Copy link
Owner

cstjean commented Jun 4, 2020

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

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

2 participants