Skip to content
Merged
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
51 changes: 51 additions & 0 deletions site/hooks/version_alias.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

"""
MkDocs hook: version URL alias.

Creates a symlink so that /docs/<icebergVersion>/ resolves to /docs/latest/.
This allows version-specific URLs (e.g. /docs/1.11.0/) to work without
duplicating the navigation entry for the latest version.
"""

import logging
from pathlib import Path

log = logging.getLogger("mkdocs.hooks.version_alias")


def on_post_build(config):
version = config["extra"].get("icebergVersion")
if not version:
return

site_dir = Path(config["site_dir"])
latest_dir = site_dir / "docs" / "latest"
version_link = site_dir / "docs" / version

if not latest_dir.exists():
log.warning("docs/latest not found in site output; skipping version alias")
return

# Remove stale symlink if the version changed between rebuilds
if version_link.is_symlink():
version_link.unlink()

if not version_link.exists():
version_link.symlink_to("latest")
log.info("Created version alias: docs/%s -> docs/latest", version)
2 changes: 1 addition & 1 deletion site/mkdocs-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ nav:
- Docs:
- Java:
# First entry determines the default landing page for the Docs tab.
- Latest (1.10.2): '!include versioned-docs/latest/mkdocs.yml'
- Latest (1.11.0): '!include versioned-docs/latest/mkdocs.yml'
- Nightly: '!include versioned-docs/nightly/mkdocs.yml'
- Other Implementations:
- Python: https://py.iceberg.apache.org/
Expand Down
4 changes: 4 additions & 0 deletions site/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ theme:
- content.code.copy
- content.code.annotate

hooks:
# Symlinks docs/<version>/ to docs/latest/ so both URLs resolve.
- hooks/version_alias.py

plugins:
- search
- blog:
Expand Down