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
1 change: 1 addition & 0 deletions docs/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ cp -rf source/* temp/
# Add user guide from published releases
rm -rf comet-0.8
rm -rf comet-0.9
rm -rf comet-0.10
python3 generate-versions.py

# Remove overview pages (this used to be part of the user guide but is now a top level page)
Expand Down
14 changes: 11 additions & 3 deletions docs/generate-versions.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,19 @@ def insert_warning_after_asf_header(root: str, warning: str):
inserted = True
file.write_text("".join(new_lines), encoding="utf-8")


def get_user_guide_dir(major_minor: str):
if major_minor == "0.8" or major_minor == "0.9":
return "docs/source/user-guide"
else:
return "docs/source/user-guide/latest"

def publish_released_version(version: str):
major_minor = get_major_minor_version(version)
dir = get_user_guide_dir(major_minor)
os.system(f"git clone --depth 1 https://github.com/apache/datafusion-comet.git -b branch-{major_minor} comet-{major_minor}")
os.system(f"mkdir temp/user-guide/{major_minor}")
os.system(f"cp -rf comet-{major_minor}/docs/source/user-guide/* temp/user-guide/{major_minor}")
os.system(f"cp -rf comet-{major_minor}/{dir}/* temp/user-guide/{major_minor}")
# Replace $COMET_VERSION with actual version
for file_pattern in ["*.md", "*.rst"]:
replace_in_files(f"temp/user-guide/{major_minor}", file_pattern, "$COMET_VERSION", version)
Expand All @@ -96,6 +104,6 @@ def generate_docs(snapshot_version: str, latest_released_version: str, previous_
if __name__ == "__main__":
print("Generating versioned user guide docs...")
snapshot_version = get_version_from_pom()
latest_released_version = "0.9.1"
previous_versions = ["0.8.0"]
latest_released_version = "0.10.0"
previous_versions = ["0.8.0", "0.9.1"]
generate_docs(snapshot_version, latest_released_version, previous_versions)
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ as a native runtime to achieve improvement in terms of query efficiency and quer
:hidden:

Comet 0.11.0-SNAPSHOT <user-guide/latest/index>
Comet 0.10.x <user-guide/0.10/index>
Comet 0.9.x <user-guide/0.9/index>
Comet 0.8.x <user-guide/0.8/index>

Expand Down