Add support for workflow code cells #80
Conversation
There was a problem hiding this comment.
Thanks @glopesdev, cool stuff! I tried this out both locally and on my fork by copying the example in Bonsai.Sleap.PredictCentroids, but the URL seems to be broken. I made a suggestion to use relative URLs instead.
It would also be nice to have this documented in the contributing guidelines. Atm the docs guidelines only exist in this open PR. For now we should open an issue to remind us to do so once this feature is merged.
|
@lochhh I have rewritten the approach to use a custom extension for consistency with the image handling pipeline. Relative and deep paths should not be affected anymore, can you give your example another try? P.S.: no need for the |
Thanks @glopesdev this is a great idea and works well with .md. I'm not sure how it works with .rst files though. In my mind I would like to have for .rst files: .. workflow:: ../../workflows/CentroidModel.bonsai
:alt: PredictCentroidsand .md files: :::{workflow} ../../workflows/CentroidModel.bonsai
:alt: PredictCentroids
:::Here is my attempt at adapting your WorkflowImageConverter for a custom WorkflowDirective (2bbc53b). |
|
@lochhh I understand the idea but are we going to have people write documentation directly in rst syntax? I would actually actively discourage this, since rst is only a standard in python, whereas markdown is more accessible. The syntax proposed in this PR is identical between docfx markdown and sphinx markdown, so I feel it might be best to unify how we document bonsai code blocks between docfx and sphinx than to force md to be compatible with rst. Ultimately all MyST code must have an equivalent in rST. Do you know what would be the .rst equivalent of the current .md syntax? |
|
@lochhh actually it looks like admonitions in MyST now support colon fences without curly brackets (executablebooks/MyST-Parser#271) which seem to be common across markdig, pandoc and now myst. |
This PR introduces a custom Sphinx extension and a new JS module for the generated website to enable rendering workflow containers. The script mimics the main features of the DocFX version, but reuses heavily the sphinx-copybutton extension.
Specifically, the markdown syntax for inserting a workflow code cell is identical to the DocFX version:
The extension expects an SVG file with the same name to be located next to the workflow, e.g. the image for the workflow above is expected at
workflows/workflow.svg.Note
Due to quirks with JS working with local files, the
fetchfunction to read contents only works if the website is being hosted from a webserver (i.e. not when opening HTML directly from files). This only affects the copy action and not the image rendering so I left it for now. Workaround is to preview the website by calling the built-in python webserverpython -m http.serverfrom the generateddocs/htmlfolder.Fixes #68