FdeSolver.jl icon indicating copy to clipboard operation
FdeSolver.jl copied to clipboard
verified publisher icon JuliaTurkuDataScience

README rendering

Open antagomir opened this issue 3 years ago • 3 comments

The current README relies on copypasted figures. Is it possible to automated figure generation. With Julia for Rmarkdown or something similar, Julia specific.

antagomir avatar Feb 20 '22 10:02 antagomir

Hi! Like many others, our package depends on Documenter.jl for the deployment of its website. There is a specific syntax to run the code and also print the results inside the docs. I can test that.

RiboRings avatar Feb 22 '22 14:02 RiboRings

Seems like a solution. A simple working example would be enough. In particular, automated generation of figures.

However the examples and their figures do not need to be in the README. Rather, README could link to the separate example pages. But those pages should use this system and render output figures automatically.

antagomir avatar Feb 22 '22 22:02 antagomir

Updates:

  • the material in the readme is automatically added to the docs without duplication
  • examples were moved to the docs and no longer appear in the readme
  • now that the code chunk of the docs are actively run, output is suppressed for nicer appearance.

Still working on:

  • add references

RiboRings avatar Feb 24 '22 13:02 RiboRings