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

docs(python): Improved structure for DataFrame and LazyFrame API docs, misc design improvements #5433

Merged
merged 2 commits into from
Nov 7, 2022
Merged

docs(python): Improved structure for DataFrame and LazyFrame API docs, misc design improvements #5433

merged 2 commits into from
Nov 7, 2022

Conversation

alexander-beedie
Copy link
Collaborator

@alexander-beedie alexander-beedie commented Nov 6, 2022

Design Update

Light mode:

  • Header navbar (and footer) background colour now matches the ice-blue titlebar of the homepage.

Screenshot 2022-11-07 at 00 22 37 Screenshot 2022-11-07 at 00 22 43

Dark mode:

Screenshot 2022-11-07 at 00 22 49 Screenshot 2022-11-07 at 00 22 55

  • Polars logo (top-left) no longer displays as black on black.
  • Titlebar colour now more visible.
  • Less stark border contrast.

Both modes:

  • Left-hand sidebar nav has a subtle background tint to better distinguish from the main body.

Improved navigation/structure

  • DataFrame and LazyFrame nav structure now updated similarly to the previous PR for Series and Expr.
  • Each of the major classes now has a more useful root page; rather than a bare list of toctree links it now contains all the methods and a neat summary table under the main class init method; handy one-stop-shop for search/lookup.
  • Side navigation breaks-out the operations by the same functional categories that were present in the previous .rst for each of the classes.

Misc

  • Hid the rightmost toctree sidebar as it doesn't show anything on most pages, and the additional space is more useful.
  • Updated LazyFrame class docstring so the associated page has a useful lead-in.
  • Slightly improved the _minify_classpaths regex in Sphinx conf.py.

@github-actions github-actions bot added docs python Related to Python Polars labels Nov 6, 2022
@ritchie46
Copy link
Member

Good improvements! Could you store/take the images in/from https://github.com/pola-rs/polars-static? That way we don't have to store binary files in this repo.

@alexander-beedie
Copy link
Collaborator Author

alexander-beedie commented Nov 6, 2022

Good improvements! Could you store/take the images in/from https://github.com/pola-rs/polars-static? That way we don't have to store binary files in this repo.

Done; once they're up I'll tweak this one accordingly 👍
(Update - ready to roll).

@ritchie46 ritchie46 merged commit 3450bc2 into pola-rs:master Nov 7, 2022
@alexander-beedie alexander-beedie deleted the sphinx-docs-structure branch November 7, 2022 09:26
zundertj pushed a commit to zundertj/polars that referenced this pull request Jan 7, 2023
@Carbocarde Carbocarde mentioned this pull request Jan 10, 2023
2 tasks
@stinodego stinodego added the documentation Improvements or additions to documentation label Jan 19, 2023
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 python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants