rugo.opteryx.dev

Documentation website for Rugo - a C++17 and Cython powered Parquet metadata reader for Python.

About

This repository contains the source code for the Rugo documentation website, hosted at https://rugo.opteryx.dev (or https://mabel-dev.github.io/rugo.opteryx.dev).

The site is built using MkDocs with the Material theme and deployed via GitHub Pages.

Local Development

To build and serve the documentation locally:

# Install dependencies
pip install -r requirements.txt

# Serve locally (with live reload)
make test
# or
mkdocs serve

# Build static site
mkdocs build

The site will be available at http://localhost:8000

Structure

• docs/ - Documentation content (Markdown files)
• mkdocs.yml - MkDocs configuration
• requirements.txt - Python dependencies
• .github/workflows/ - GitHub Actions for deployment

Contributing

Contributions to improve the documentation are welcome! Please:

1. Fork this repository
2. Make your changes
3. Test locally with mkdocs serve
4. Submit a pull request

License

Licensed under the Apache License 2.0. See LICENSE for details.