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

Migrating to the PyData theme for the online docs #576

Merged
merged 16 commits into from
Sep 2, 2024
Merged

Migrating to the PyData theme for the online docs #576

merged 16 commits into from
Sep 2, 2024

Conversation

maximelucas
Copy link
Collaborator

This switches the theme of the onlines docs to the PyData theme.

Some reorganization is needed to fit with the theme.

Copy link

codecov bot commented Sep 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.13%. Comparing base (7335eca) to head (5f56d6c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #576   +/-   ##
=======================================
  Coverage   93.13%   93.13%           
=======================================
  Files          60       60           
  Lines        4503     4503           
=======================================
  Hits         4194     4194           
  Misses        309      309           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@maximelucas maximelucas marked this pull request as ready for review September 1, 2024 18:51
@nwlandry
Copy link
Collaborator

nwlandry commented Sep 2, 2024

I won't have the chance to do a thorough review by the time you need it, but overall looks great! Thanks for making this happen!

Quick things I noticed:

  • where is the using XGI page?
  • XGI-DATA table looks funky in dark mode
  • "Copyright Copyright" in the footer
  • In the side bar under API, "Linear Algebra" instead of "Linalg" and might want to revisit other names as well for maximum explainability?
  • In the API sidebar, do we really need the full path of all modules? It's pretty verbose.

I really like what you did with the installation guide and the tutorials!

@maximelucas maximelucas changed the title Using the PyData theme for the online docs Migrating to the PyData theme for the online docs Sep 2, 2024
@maximelucas
Copy link
Collaborator Author

Thanks for the quick initial review Nich!

  • "projects using XGI" page is linked to in text of the home page.
  • good catch, I disabled the mode switch for now
  • about the paths, I managed to shorted them for the functions, but not the module paths in the toc (it was like that in our current online docs already). I suggest we can try again in another PR

@maximelucas
Copy link
Collaborator Author

Summary of what I did for the record:

  • New 1-level structure is now: Homepage, Installing, User Guides, API Reference, XGI-DATA, Gallery, and Development
  • Homepage: is now more concise (I moved some sections in other places and linked them)
  • Installing: concise but links to a "more options" page
  • User Guides: new page, presenting the categories of tutorials
  • API Ref: added a small description of the API at the top
  • XGI-Data: added link to documentation (fix cannot easily find the functions for loading the datasets in the docs? #548)
  • Development: now combines "Contribute" and "Contributors"

I have ideas of options of things to add in the future, maybe a page for Releases, a better Gallery, etc.

xgi-data
gallery
using-xgi
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you restore using-xgi in the sidebar?

@maximelucas maximelucas merged commit 851460b into main Sep 2, 2024
24 checks passed
@maximelucas maximelucas deleted the pydata branch September 2, 2024 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants