Skip to content

Commit e6fc7ff

Browse files
authored
docs: Publish 0.10.0 user guide (#2394)
1 parent 96ede70 commit e6fc7ff

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

docs/build.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ cp -rf source/* temp/
2727
# Add user guide from published releases
2828
rm -rf comet-0.8
2929
rm -rf comet-0.9
30+
rm -rf comet-0.10
3031
python3 generate-versions.py
3132

3233
# Remove overview pages (this used to be part of the user guide but is now a top level page)

docs/generate-versions.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,19 @@ def insert_warning_after_asf_header(root: str, warning: str):
6565
inserted = True
6666
file.write_text("".join(new_lines), encoding="utf-8")
6767

68+
69+
def get_user_guide_dir(major_minor: str):
70+
if major_minor == "0.8" or major_minor == "0.9":
71+
return "docs/source/user-guide"
72+
else:
73+
return "docs/source/user-guide/latest"
74+
6875
def publish_released_version(version: str):
6976
major_minor = get_major_minor_version(version)
77+
dir = get_user_guide_dir(major_minor)
7078
os.system(f"git clone --depth 1 https://github.com/apache/datafusion-comet.git -b branch-{major_minor} comet-{major_minor}")
7179
os.system(f"mkdir temp/user-guide/{major_minor}")
72-
os.system(f"cp -rf comet-{major_minor}/docs/source/user-guide/* temp/user-guide/{major_minor}")
80+
os.system(f"cp -rf comet-{major_minor}/{dir}/* temp/user-guide/{major_minor}")
7381
# Replace $COMET_VERSION with actual version
7482
for file_pattern in ["*.md", "*.rst"]:
7583
replace_in_files(f"temp/user-guide/{major_minor}", file_pattern, "$COMET_VERSION", version)
@@ -96,6 +104,6 @@ def generate_docs(snapshot_version: str, latest_released_version: str, previous_
96104
if __name__ == "__main__":
97105
print("Generating versioned user guide docs...")
98106
snapshot_version = get_version_from_pom()
99-
latest_released_version = "0.9.1"
100-
previous_versions = ["0.8.0"]
107+
latest_released_version = "0.10.0"
108+
previous_versions = ["0.8.0", "0.9.1"]
101109
generate_docs(snapshot_version, latest_released_version, previous_versions)

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ as a native runtime to achieve improvement in terms of query efficiency and quer
5050
:hidden:
5151

5252
Comet 0.11.0-SNAPSHOT <user-guide/latest/index>
53+
Comet 0.10.x <user-guide/0.10/index>
5354
Comet 0.9.x <user-guide/0.9/index>
5455
Comet 0.8.x <user-guide/0.8/index>
5556

0 commit comments

Comments
 (0)