This repo contains the User Guide for the Polars DataFrame library.
The User guide is made with Material for mkdocs. In order to get started with building this book perform the following steps:
make requirements
In order to serve the books run make serve. This will run all the python examples and display the output inline using the markdown-exec plugin.
Deployment of the book is done using Github Pages and Github Workflows. The book is automatically deployed on each push to master / main branch. There are a number of checks in the CI pipeline to avoid non-working examples:
- Run all python examples, fail on any errors
- Run all node examples, fail on any errors
- Check all links in markdown
- Run black formatter