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

Make API Reference page tell me something I want to know #98

Open
leifwalsh opened this issue Oct 17, 2018 · 0 comments
Open

Make API Reference page tell me something I want to know #98

leifwalsh opened this issue Oct 17, 2018 · 0 comments

Comments

@leifwalsh
Copy link
Contributor

Linking yourself through this page is sort of the fastest way to the docstrings, but it's kind of a stark thing to land on. We should put some text here that welcomes the reader and points them to the right next thing to click: https://marbles.readthedocs.io/en/stable/reference.html

Also, maybe the module docstring summaries, maybe also go one level deeper on the toctree?

@leifwalsh leifwalsh added the docs label Oct 17, 2018
@leifwalsh leifwalsh added this to To do in General improvements via automation Oct 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

1 participant