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

README rendering #44

Open
antagomir opened this issue Feb 20, 2022 · 3 comments · Fixed by #46
Open

README rendering #44

antagomir opened this issue Feb 20, 2022 · 3 comments · Fixed by #46
Assignees

Comments

@antagomir
Copy link
Contributor

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

@RiboRings
Copy link
Member

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.

@antagomir
Copy link
Contributor Author

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.

@RiboRings RiboRings linked a pull request Feb 23, 2022 that will close this issue
@RiboRings RiboRings reopened this Feb 24, 2022
@RiboRings
Copy link
Member

RiboRings commented Feb 24, 2022

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

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

Successfully merging a pull request may close this issue.

2 participants