Docs#35
Conversation
| def get_reference_docs(): | ||
| """Create reference documentation from the source code. | ||
| A bit like Sphinx autodoc, but using Markdown, and more basic. | ||
| Returns a str in Markdown format. | ||
|
|
||
| Note that this function is used to build the Dash Slicer chapter | ||
| in the Dash docs. | ||
| """ |
There was a problem hiding this comment.
I'm not really sure whether to put his here or in dash-docs. The only real advantage is that we can also add our reference docs to the readme, but perhaps we should just provide a link to https://dash.plotly.com/slicer
There was a problem hiding this comment.
Thoughts welcome :)
There was a problem hiding this comment.
I think it's a good idea to have it here if in dash-docs you can just call this function.
|
(I know what to do about the Windows CI error, but I'll wait with a fix until we figure out how to move forward) |
|
|
||
| Note that this is not a Dash component. The components that make | ||
| up the slicer (and which must be present in the layout) are: | ||
| `slicer.graph`, `slicer.slider`, and `slicer.stores`. |
There was a problem hiding this comment.
| `slicer.graph`, `slicer.slider`, and `slicer.stores`. | |
| `slicer.graph`, `slicer.slider` (optional in layout if several slicers are used), and `slicer.stores`. |
There was a problem hiding this comment.
Unfortunately it is not optional, because we have it as input and output to our callbacks.
|
I approved a bit too fast (there's the Windows CI problem you mentioned), just wanted to say that the approach is sound I think. |
Co-authored-by: Emmanuelle Gouillart <emma@plot.ly>
Prerequisite for https://github.com/plotly/dash-docs/pull/1039
docsmodule with a few simple utilities: