Small docs update - Githubissues

cdeil commented 7 years ago

This PR:

Changes the table of content and sidebar as shown in the screenshot
Moves the "tile drawing algorithm page" into the developer docs section (as most users won't read through it) and shortens the headings so that they are readable in the table of content side bar. Otherwise it's just whitespace formatting changes. Hope that change is OK @tboch .
Adds a very small page with developer info (we can extend later)

cdeil commented 7 years ago

Merging this now. Comments / suggestions still welcome!

tboch commented 7 years ago

this update is fine for me

adl1995 commented 7 years ago

This looks good! Should we also add a section named "Guides" as we move along? This could contain small tutorial(s) on how to use the package.

cdeil commented 7 years ago

Should we also add a section named "Guides" as we move along? This could contain small tutorial(s) on how to use the package.

My suggestion would be that as we add functionality, we make sure to add good docstrings (in some cases with Examples sections at the end, so that over time our API docs become nice: https://hips.readthedocs.io/en/latest/api.html

For high-level, tutorial-style docs, as we develop functionality, we fill this page: https://hips.readthedocs.io/en/latest/getting_started.html

And then if we have developed a lot of functionality and the single getting started page gets too long, we have a conversation about our docs and refactor it into a larger set of pages.

That said, @adl1995 - of course suggestions / pull requests are welcome any time! Just in case it's something larger that you'd have in mind (i.e. that would take a day or more to write up), please make an issue proposing / outlining the addition or change before implementing it.

hipspy / hips

Small docs update #15