Skip to content

ADBC Driver Foundry Website

Source code for the ADBC Driver Foundry website, including driver documentation, the Foundry blog, and information about the project. This project uses Sphinx and can be built with Pixi.

Building

Prerequisites

Build and Preview

Build the site with:

$ pixi run build

To preview the site you built, run:

$ pixi run serve

Then open your web browser to http://localhost:8000.

For development, you can instead use the development server which will automatically rebuild the site when changes are made:

$ pixi run watch

Then visit http://localhost:8000.

Note that the theme used does not always work well with incremental builds. You may need to remove _build and start again, especially when changing theme options.

Adding a blog post

Blog posts are regular MyST Markdown documents stored at blog/YYYY/MM/DD/post-slug.md. Mark the document with blogpost: true and a date in its YAML front matter; ABlog then adds it to /blog/ and the Atom feed. The source path intentionally produces a clean date-based public URL, such as /blog/2026/07/20/updated-spark-driver/. The build also writes redirects from the post's former root-level .html and trailing-slash URLs so existing links continue to work.

Use an existing post as the template so the author/date byline and page options remain consistent. Ensure that hide-toc: true and orphan: true are included in the YAML.

Domains

The canonical production domain is adbc-drivers.org. The GitHub Pages custom domain for this repository must be set to that apex domain. The legacy docs.adbc-drivers.org host should issue a permanent redirect to the same path, query, and fragment on adbc-drivers.org; the site also includes a client-side host redirect as a fallback when the legacy hostname serves this artifact.

Contributing

See CONTRIBUTING.md for information on how to contribute.

About

Website for adbc-drivers.org

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

2 watching

Forks

Contributors

Languages