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

front facing docs page #110

Closed
JessicaS11 opened this issue Jul 30, 2020 · 2 comments · Fixed by #260
Closed

front facing docs page #110

JessicaS11 opened this issue Jul 30, 2020 · 2 comments · Fixed by #260
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JessicaS11
Copy link
Member

Turn the front-facing documentation page into a one-stop-shop of information about icepyx (both on GitHub and ReadTheDocs). @fspaolo suggested Jekyll's page as an example - everything is captured simply and easily without scrolling. We'd like to implement something analogous for icepyx - all the resources easily accessible in the first place people see!

@JessicaS11 JessicaS11 added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jul 30, 2020
@fspaolo
Copy link

fspaolo commented Jul 31, 2020

An alternative to Jekyll is Hugo. Both are well maintained and have a large community. All we need to do is select a theme from their galleries and add it to the icepyx repo as GitHub Pages.

Jekyll themes: https://jamstackthemes.dev/ssg/jekyll/

Hugo themes: https://themes.gohugo.io/

(you can loose yourself choosing... I warn you)

@weiji14
Copy link
Member

weiji14 commented Apr 9, 2021

A few projects in the PyData ecosystem have been moving towards using the PyData Sphinx Theme. E.g. geopandas (geopandas/geopandas#1564) and xarray (pydata/xarray#4835). The 'front page' seems fairly customizable, and it'll probably be easier to port things over from the current Read the Docs Sphinx Theme icepyx is using.

image

If this looks like a good plan, I can open a Pull Request for this and get a demo up and running 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants