Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More explicit linking to autodoc content within documentation #106

Open
Islast opened this issue Mar 27, 2019 · 2 comments
Open

More explicit linking to autodoc content within documentation #106

Islast opened this issue Mar 27, 2019 · 2 comments
Assignees

Comments

@Islast
Copy link
Collaborator

Islast commented Mar 27, 2019

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
Copy link
Collaborator

@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
Copy link
Collaborator Author

Islast commented Apr 1, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants