You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For 'advanced beginners' it would be really useful to have a single website for an as complete as possible class, function, and attribute level documentation on a single reference website. I'll just throw this example out there as how this could look like. The advantage of this is that one can simply Ctrl+F for a certain feature and immediately glean from it in which file or submodule to look.
Keeping such a reference is made easy both initially and maintaining it as well. And I briefly outline the steps required:
Oh, wow, seems like idea has been picked up. So much docs to read. Everybody who comes across it: please feel free to submit pull requests for docstrings and such. More about writing strings for Sphinx and be found here
For 'advanced beginners' it would be really useful to have a single website for an as complete as possible class, function, and attribute level documentation on a single reference website. I'll just throw this example out there as how this could look like. The advantage of this is that one can simply Ctrl+F for a certain feature and immediately glean from it in which file or submodule to look.
Keeping such a reference is made easy both initially and maintaining it as well. And I briefly outline the steps required:
If @ajmedford would initiate step 1. & 3. I will be more than happy to contribute step 2., maybe next Wednesday?
The text was updated successfully, but these errors were encountered: