-
Notifications
You must be signed in to change notification settings - Fork 74
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
Redesign the front page of the docs #238
Conversation
Includes some of the info from the README
Using sphinx-panels to define blocks and cards
@prisae @aguspesce @santisoler what do you think? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it, I think it makes it easier to get started. Also the new tabs on the About and Installing sections look neat!
This looks awesome! I ❤️ the tabs! And the cards in the front page looks amazing. The only thing I would change is the color of the text inside the buttons when hovering. Currently, when hovering over the buttons, the text inside them is shown in the same original blue color, while the button itself fills with another tone of blue, drastically lowering the contrast of the text and its background. Besides the aesthetics, I think we should change that to improve accessibility. |
Thanks @santisoler @prisae! That was an easy fix. Merging this in! |
Remove the wall of text and make clear boxes for getting started, asking for help, API reference, and citing. Include the full table of contents underneath to help with navigation. Move the text about different use cases to a "Why Pooch?" page. Introduces the
sphinx-panels
extension to use cards, columns, and tabs.Preview of the built docs: https://www.leouieda.com/docs-previews/pooch/238/
Reminders:
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
and the base__init__.py
file for the package.AUTHORS.md
file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.