Skip to content
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

Workflow container padding lost for workflows >3 levels high #181

Open
banchan86 opened this issue Jan 8, 2025 · 2 comments
Open

Workflow container padding lost for workflows >3 levels high #181

banchan86 opened this issue Jan 8, 2025 · 2 comments

Comments

@banchan86
Copy link

Just wanted to let you all know that there is a pretty obscure bug described @bonsai-rx/docfx-tools#19 for the Bonsai workflow container where basically workflow images more than 3 levels high lose their padding.

A relevant example on these docs: https://open-ephys.github.io/bonsai-onix1-docs/articles/hardware/np2e/np2.html

There is a potential fix available at bonsai-rx/docfx-tools#20 but I haven't tried it out. If you all don't want to wait wait for the docfx-tools submodule to be updated, can try it out for yourselves!

@bparks13
Copy link
Member

bparks13 commented Jan 8, 2025

Is there a way to disable this renderClickableImage method from running for the workflow images? Unless I'm missing something, we don't typically need the image to be clickable, we just want the XML to be copyable which is a different system that's already handled.

Either way, thanks for pointing this out!

@banchan86
Copy link
Author

That's a good point, it is a bit weird to have clickable workflow containers (and for only a few of them). Seems like they added it so that people could click on image galleries (https://dotnet.github.io/docfx/extensions/templates.html).

  • I tried looking at docfx.json, but it doesn't seem to be an exposed property.
  • As the script is part of the docfx core modern template (specifically the src/markdown.ts file), I tried to see if it was possible to overwrite it with a copy of the file (similar to how Cris did it for the managedreference templates) but seems like only those files which can be seen by docfx template export modern can be overwritten.

We could investigate it further, but in the interim, the fix by @lochhh has been merged into docfx-tools @bonsai-rx/docfx-tools#20.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants