An open API service indexing awesome lists of open source software.

https://github.com/adbc-drivers/docs.adbc-drivers.org

Website for docs.adbc-drivers.org
https://github.com/adbc-drivers/docs.adbc-drivers.org

adbc

Last synced: 5 months ago
JSON representation

Website for docs.adbc-drivers.org

Awesome Lists containing this project

README

          

# ADBC Driver Foundry Documentation

Source code for the [ADBC Driver Foundry](https://adbc-drivers.org) driver documentation [website](https://docs.adbc-drivers.org).
This project uses [Sphinx](https://sphinx-doc.org) and can be built with [Pixi](https://pixi.sh).

## Building

## Prerequisites

- [Pixi](https://pixi.sh) (see [Pixi Installation](https://pixi.sh/latest/installation/))

## Build and Preview

Build the site with:

```console
$ pixi run build
```

To preview the site you built, run:

```console
$ pixi run serve
```

Then open your web browser to .

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

```console
$ pixi run watch
```

Then visit .

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.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to contribute.