search

WhitakerLab / scona

Code to analyse structural covariance brain networks using python.
https://whitakerlab.github.io/scona/
MIT License
67 stars 33 forks source link

More explicit linking to autodoc content within documentation #106

Open Islast opened 5 years ago

Islast commented 5 years ago

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

wingedRuslan commented 5 years ago

@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?

Islast commented 5 years ago

I was meaning to add links to these pages, not to the readme, but to the introduction.rst file that builds into the introduction page in the docs