matnwb
matnwb copied to clipboard
NeurodataWithoutBorders
API generation tool is dangerously deprecrated
Hey @ln-vidrio, it looks like the API index is out of date. Would you be able to update it? How straightforward would it be to maintain old versions of the schema as well?
The current tool I'm using no longer works with newer MATLAB versions so a better solution may be required. I can update the current API docs for 2.4.0. What do you mean by maintaining old versions of the schema or do you mean expanding the docs to all available versions?
The current tool I'm using no longer works with newer MATLAB versions so a better solution may be required
Dang, that's a bummer.
expanding the docs to all available versions
This sounds like what I mean. Like with MATLAB you can select documentation from a previous version. Not a huge deal, but might be nice to have. I'm more interested getting the API docs updated.
Like with MATLAB you can select documentation from a previous version
So you can technically do this by linking to a specific git commit right now but I get what you mean. I can attempt something like this but that'll depend on what tools I'm using.
Do you think we could use something like this?
This is good but would require some automation work to get info.xml correct. It might be worth it though I'll have to think about it.
Actually, looking at the link again, we do need static HTMLs for the pages on GitHub though I wonder how many users actually reference these API docs instead of locally.
Well I came across this because I was trying to link to the API from the new icephys tutorial and realized that the new types are not in the docs. I'd be fine with changing it to a different form, and changing the URL would be OK, but it would be nice to have some static URL for the API that we can link to from the tutorials
I've updated the API but I'll leave this issue open for the feature request.
awesome, thanks! This is most of what I wanted. The rest was just exploring ways we could improve the docs.