Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Description
The "tutorials" section of the docs is really mostlynot a tutorial, but long-form discussion of library features, and how the library works. These are done using sphinx-gallery, which is quite convenient for writing docs with lots of plotting examples in them.
I would argue that much of the material in Tutorials should be considered part of the Users Guide, and organized in the TOC that way. It's possible some of the "tutorials" could just be made rst files, and edited in rst going froward. That would ideally require some sort of tool to "run" all the.. plot::
directives in the rst without compiling the whole doc suite. Such a tool would be generally useful as well, and shouldn't be that hard to make. However, even leaving the "tutorials" as sphinx-gallery python files may be fine if we organize them in the User Guide TOC.