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

generate schema doc from docstring #9

Open

Roger-luo opened this issue May 3, 2021 · 0 comments

Owner

Roger-luo commented May 3, 2021

in principle we can have the following syntax and generate the corresponding markdown from it

"""
    struct Payload

the payload type
"""
struct Payload
    "a header"
    header::Header
    "a config"
    config::Config
    "some instructions"
    instructions::Vector{Instruction}
end

which generate the following markdown

    struct Payload

the payload type

# Fields

- `header::Header`: a header.
- `config::Config`: a config.
- `instructions::Vector{Instruction}`: some instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment