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.

Sign up for GitHub

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

Jump to bottom

Add template for examples and docs based on Literate.jl #4

Closed
mtfishman opened this issue Nov 21, 2024 · 0 comments · Fixed by #19
Closed

Add template for examples and docs based on Literate.jl #4

mtfishman opened this issue Nov 21, 2024 · 0 comments · Fixed by #19

Comments

@mtfishman
Copy link
Member

Add an examples/README.jl in the Literate.jl format and a workflow in docs/make.jl that calls Literate.markdown on examples/README.jl to generate docs/src/index.md. Then, define README.md as a link to docs/src/index.md, and call examples/README.jl from the tests.

In that way, examples/README.jl acts as both an example, documentation, a README, and a set of tests. We should set this up both in templates/default and in the package itself.

See ITensor/BroadcastMapConversion.jl#1 as a reference.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update README and docs generation ITensor/ITensorPkgSkeleton.jl
1 participant
@mtfishman