Skip to content

Commit 9c8fcc3

Browse files
author
nullccxsy
committed
feat: add initial documentation website
- Add MkDocs-based documentation website with Material theme - Include basic pages: Home, Configuration, Examples, Contributing, Releases - Add API documentation structure for Table, Catalog, Schema, Types, and Table Scan - Add build script for local documentation generation - Add GitHub Actions workflow for automatic deployment to GitHub Pages - Configure custom domain cpp.iceberg.apache.org Note: This is a demo version with placeholder content that needs further refinement.
1 parent 4cb4d61 commit 9c8fcc3

23 files changed

+1312
-909
lines changed

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
cpp.iceberg.apache.org

docs/README.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

docs/build-docs.sh

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
#!/bin/bash
2+
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
20+
set -e
21+
22+
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
23+
PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
24+
25+
cd "$PROJECT_ROOT"
26+
27+
echo "Building Iceberg C++ documentation..."
28+
echo "Working directory: $(pwd)"
29+
30+
if ! command -v mkdocs &> /dev/null; then
31+
echo "Error: mkdocs is not installed"
32+
exit 1
33+
fi
34+
35+
echo "Installing MkDocs dependencies..."
36+
pip install mkdocs-material
37+
38+
echo "Building MkDocs documentation..."
39+
mkdocs build --config-file docs/mkdocs.yml
40+
41+
echo "Documentation build completed successfully!"
42+
echo "MkDocs site: docs/site/"

docs/configuration.md

Lines changed: 0 additions & 263 deletions
This file was deleted.

0 commit comments

Comments
 (0)