Comments (8)
After thinking about this for a while I think the best place would be to change https://github.com/JuliaPlots/Plots.jl/blob/master/src/arg_desc.jl to be a Vector{NamedTuple}
with attribute
, docstring
, example
fields.
This way the examples can also be shown by the plotattr
function in the REPL and then we only need a good place in the docs to create and render all the figures.
from plotdocs.jl.
That depends on whether these links should also be displayed when people use the plotattr
function from the REPL.
I don't think it is a good idea to store directly the URLs in that dict.
Maybe its good to store the numbers of the examples in that dict and generate the links at documentation build time.
That may get forgotten when new examples get added, but would be less complex than extracting from the examples what attributes got used.
from plotdocs.jl.
That works for me, I don't want to add things to your place but I am happy to find all the example projects and link them if you or someone else set's up the hooks for the links to be generated at build time.
from plotdocs.jl.
We might need to clarify what you mean by "example links". I thought we are talking about these. For examples in other packages we have the ecosystem section
from plotdocs.jl.
All I mean by "example links" is a link on each attribute a user can click on and then see said attribute in action. This will hopefully serve as a way to bridge the theoretical and practical in this content.
from plotdocs.jl.
I am still confused whether those links should point to the existing examples page, to examples that are created for that purpose or to examples that are somewhere in the wild.
from plotdocs.jl.
I think existing examples within the docs is probably better so we don't need to worry about external links disappearing. I'm guessing all of the attributes may not be present in the current docs but I (or others) can add examples or add the attributes to existing examples.
from plotdocs.jl.
I see. This sounds like a useful idea. For this purpose it would make sense to generate these examples in this repository since the existing examples test many different things at once since they are used for the visual regression tests.
But for such reference examples it would actually be better to show the effect of each attribute in isolation or useful context.
from plotdocs.jl.
Related Issues (20)
- Add documentation on functions gif, mov, mp4 and webm.
- GR Backend: Colorbar title text inside ticks HOT 2
- join GSoD'22? HOT 3
- `PlotlyJS` gallery is failing to show the rendered image HOT 1
- Custom ticks on a log scale in PGFPlots is broken
- normed options for histogram is not documented HOT 2
- could not load library "libGR.so" HOT 1
- Legend not well documented HOT 1
- Search often not showing most relevant results HOT 2
- All attributes manuals are broken HOT 3
- Plotly plot not displaying in tutorial HOT 5
- Reorganize attribute documentation HOT 14
- using Plots; pyplot() breaks docs HOT 1
- Pipeline example broken HOT 7
- Table shows unevaluated Markdown HOT 1
- Using variables in sizing subplots via curly brackets HOT 1
- Document `:latex` functionality for axis attribute `formatter` HOT 1
- kindlmann colormap HOT 1
- matplotlib API change blocked CI. HOT 1
- Precompile fails in Julia 1.10.3: buffer overflow HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from plotdocs.jl.