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
scona is documented via docstrings see our developers guide for details. This is really great and it means that when you go to our website you can type any function into the search bar and (in theory) come up with some results.
HOWEVER, this isn't really highlighted within the website. If you go to the front page and scroll down you'll see some links to index and module index which will take you to pages at the top of the tree created by autodoc, but that's it.
I would like to link directly to these pages in the introduction, perhaps under finding help or getting started, to say we have automatically generated docstring documentation and here's how to navigate to it. This should link to the submodules page, the index, the module index and inform readers that they can use the search bar to look up functions
The text was updated successfully, but these errors were encountered:
@Islast do I understand your idea right? would you like to have readme file updated, so that there will be links to 1)submodules page, 2)the index, 3)the module index in the get started section?
scona is documented via docstrings see our developers guide for details. This is really great and it means that when you go to our website you can type any function into the search bar and (in theory) come up with some results.
HOWEVER, this isn't really highlighted within the website. If you go to the front page and scroll down you'll see some links to
index
andmodule index
which will take you to pages at the top of the tree created by autodoc, but that's it.I would like to link directly to these pages in the introduction, perhaps under finding help or getting started, to say we have automatically generated docstring documentation and here's how to navigate to it. This should link to the submodules page, the index, the module index and inform readers that they can use the search bar to look up functions
The text was updated successfully, but these errors were encountered: