Add Polars documentation#2685
Open
mcagriardic wants to merge 1 commit into
Open
Conversation
Add a scraper for the Polars Python API reference (https://docs.pola.rs/api/python/stable/reference/), pinned to the stable 1.41.0 release. The site uses the pydata-sphinx-theme, so the scraper reuses the shared sphinx/clean_html filter alongside Polars-specific filters: - clean_html removes the theme chrome (sidebars, in-page TOC, prev/next navigation, footer) and tags code blocks for Python highlighting. - entries names each page from its heading and groups entries into types (DataFrame, LazyFrame, Series, Expressions, Functions, Data Types, Input/output, etc.). Top-level members are stored flat under api/ and are classified by their member name. Latest-version detection uses the most recent GitHub release and strips the py- prefix, since the repo also tags Rust (rs-) releases.
Author
|
@simon04, would appreciate reviews. Many thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a scraper for the Polars Python API reference
(https://docs.pola.rs/api/python/stable/reference/), pinned to the stable 1.41.0 release.
The site uses the pydata-sphinx-theme, so the scraper reuses the shared sphinx/clean_html filter alongside Polars-specific filters:
Latest-version detection uses the most recent GitHub release and strips the py- prefix, since the repo also tags Rust (rs-) releases.
If you’re adding a new scraper, please ensure that you have:
public/icons/docs/polars/directory:16.png: a 16×16 pixel icon for the doc16@2x.png: a 32×32 pixel icon for the docSOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itselfimage:
