-
Notifications
You must be signed in to change notification settings - Fork 96
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
[WIP] Enhance attribute docs #334
base: master
Are you sure you want to change the base?
Conversation
96c8495
to
5d4ed4e
Compare
That is a good first step in that we now have a clear vision what the output should look like, but in order to not have to update this once we change something in Plots we need to generate these pages from the information in Plots. For example you can generate a simple mardown document like this: using Markdown
a = 2
md_doc = MD()
push!(md_doc, md"""
# Header
`a` has the value $(a).
""")
open("test.md", write = true) do io
print(io, md_doc)
end |
Yeah, otherwise this will be a nightmare for maintainability. |
What would be the cleanest way to make sure there are sections for Subplot and Axis attributes, e.g. annotation, colorbar, etc. so that they show up on the dropdown menu, like how it's done in the commit beforehand? That's an important thing that needs to be done imo. Wouldn't those changes have to be made in Plots.jl since it would be beneficial to be able to do |
I have no idea what the final solution would look like but changes can be made in Plots to accompany this PR. Clarity and concision should be preferred. |
See relevant PR |
@Ininterrompue, could you post screenshots (after a local docs build against this PR) of what this would look like ? It's a bit hard to approve without having an overview of the final result ... |
Reformats docstrings.