Skip to content

Versioned docs are not rendered - no error raised #181

@goergen95

Description

@goergen95

Prework

Description

When trying to enable versioned docs, great-docs seems to successfully build pages for different versions, but in fact, the sites are actually empty and only the redirects were written.

Reproducible example

I tried to figure out a minimal reproducible example but I was not able to reproduce so
the best I can do is to describe the bug in the context of my specific project.

To clone the repository and set up the environment:

git clone git@github.com:goergen95/seapig.git
cd seapig
git switch docs
uv venv
source .venv/bin/activate
uv pip install ".[all]"

On the docs branch I have the following added to my config:

versions:
    - label: "0.2.0 (dev)"
      tag: dev
      version: "0.2.0"
      prerelease: true
    - label: "0.1"
      tag: "0.1"
      git_ref: v0.1.0
      latest: true

There, I see:

❯ great-docs versions
  TAG          LABEL                STATUS           API SOURCE
  ──────────── ──────────────────── ──────────────── ────────────────────────
  dev          0.2.0 (dev)          prerelease       live introspection
  0.1          0.1                  latest ✓         git tag: v0.1.0

The site seems to build successfully. Preview then however fails, since
the site was not actually built.

great-docs build
great-docs preview
❌ Could not find built site

This is surprising, since I actually see

━━ Step 16/18 ─ Build site with Quarto ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
      Multi-version build: 2 version(s)
   ✔ 2 version(s) rendered

but nothing is being build here. I encounter the same issue on CI where the build also seems to run successfully but quarto is actually not rendering.

Deleting the versions block in the YAML renders the single version site just fine.

Expected result

I expected the site to build for multiple versions that I can preview locally or deploy via CI.

Development environment

  • Operating System: Linux
  • Great Docs Version: 0.10.0 (also tested with 0.11.0)

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions