Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,17 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: prefix-dev/setup-pixi@82d477f15f3a381dbcc8adc1206ce643fe110fb7
with:
python-version: '3.13'
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
pixi-version: v0.59.0
cache: true
environments: docs
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ github.ref }}
path: ~/.cache
- name: Build site
run: |
mkdocs build --strict
run: pixi run -e docs mkdocs build --strict
- name: Upload built site as artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
18 changes: 3 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,14 @@ limitations under the License.
# dbc docs

dbc uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) for docs.
Building the docs requires a Python installation and a number of system libraries for social image generation.

## Setup

From the root of the repository, run:

```sh
uv venv
source .venv/bin/activate
uv pip install -r docs/requirements.txt
```

Then install the necessary graphics libraries from https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/#cairo-graphics.
Building the docs requires a [Pixi](https://pixi.sh/) installation.

## Building

To build the docs website, run,

```sh
mkdocs build
pixi run docs-build
```

The built docs website will be in `./site` and you can preview it by running this (or something similar):
Expand All @@ -50,5 +38,5 @@ python -m http.server -d site
mkdocs has live preview+reload. To use it while developing, run:

```sh
mkdocs serve
pixi run docs-serve
```
2 changes: 0 additions & 2 deletions docs/requirements.txt

This file was deleted.

Loading
Loading