Open stefanv opened 1 year ago
commenting because I can't self-assign. I would love to see some of the materials in our (MNE-Python's) docs get superseded by ecosystem-level tutorials. I'm imagining things like
main
, etc)CONTRIBUTING.md
?) regardless of what package they happen to be contributing to.obviously there will be some degree of variability across packages in how each of these things are done, but that's an opportunity for figuring out which ones have a clear best-practice (that could be codified in a SPEC?) and which are cases of "reasonable packages will disagree". For the latter cases, the ecosystem-level tutorial would be either more conceptual (individual package docs fill in the details) or simply not exist.
we are working on some tutorial content but it will be focused around packaging.
This meant focusing entirely on shared infrastructure, not at all on content, and not about a tutorial about that infrastructure. As far as I see there are no content-related topics suggestions yet, if that's something you would be interested doing, it could go into a separate issue.
This meant focusing entirely on shared infrastructure, not at all on content, and not about a tutorial about that infrastructure.
new issue created (#21)
One thing I'd personally be interested in is seeing whether/how various tools can be used in conjunction with one another. For example, there are several tutorials sites (numpy-tutorials, nx-guides) built on top of the executable books stack that would also benefit from e.g. the thumbnail feature from sphinx-gallery. It's not immediately obvious how the executablebook sphinx extensions & sphinx-gallery can be used together.
In a similar but broader vein - I'd like to investigate the browser-native tooling and see how well/easily existing tutorial content (based on static site generation) is supported.
I've just run into nbmake right now, and wonder how does that compare to nbval for notebook testing.
id love to participate here as well. we are working on some tutorial content but it will be focused around packaging.