From 39dffebf418cf0cfb3ac787d061170c7c54ca904 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 11 Oct 2025 12:29:57 -0400 Subject: Revert "Add support for versioned docs" This reverts commit 3cd15cb2e3aecc4c2e1e553d9ac7e4a7a67c46b1. --- .builds/docs.yml | 10 ---- docs/javascripts/version-selector.js | 39 ------------- mkdocs.yml | 3 - scripts/deploy-docs.sh | 104 +++-------------------------------- 4 files changed, 9 insertions(+), 147 deletions(-) delete mode 100644 docs/javascripts/version-selector.js diff --git a/.builds/docs.yml b/.builds/docs.yml index 4316feb..dfa8ac9 100644 --- a/.builds/docs.yml +++ b/.builds/docs.yml @@ -6,9 +6,6 @@ packages: - mkdocs-material - py3-regex - hut - - jq - - rsync - - git secrets: - ac3eecc9-8fb0-4ed4-ae53-0472c093a1f1 sources: @@ -16,11 +13,4 @@ sources: tasks: - deploy: | cd bolt - - if git describe --exact-match --tags HEAD 2>/dev/null; then - export VERSION=$(git describe --exact-match --tags HEAD) - else - export VERSION=latest - fi - ./scripts/deploy-docs.sh diff --git a/docs/javascripts/version-selector.js b/docs/javascripts/version-selector.js deleted file mode 100644 index fb0a187..0000000 --- a/docs/javascripts/version-selector.js +++ /dev/null @@ -1,39 +0,0 @@ -(function () { - fetch("/versions.json") - .then((r) => r.json()) - .then((data) => { - const currentPath = window.location.pathname; - const pathParts = currentPath.split("/").filter((p) => p); - const currentVersion = pathParts[0] || "latest"; - - const header = document.querySelector(".md-header__inner"); - if (!header) return; - - const select = document.createElement("select"); - select.className = "md-version-select"; - select.style.cssText = - "margin-left: 1rem; padding: 0.25rem 0.5rem; border-radius: 0.25rem; background: var(--md-default-bg-color); border: 1px solid var(--md-default-fg-color--lighter);"; - - data.versions.forEach((v) => { - const option = document.createElement("option"); - option.value = v.version; - option.textContent = v.title; - if (v.version === currentVersion) { - option.selected = true; - } - select.appendChild(option); - }); - - select.addEventListener("change", (e) => { - const newVersion = e.target.value; - const remainingPath = pathParts.slice(1).join("/"); - window.location.href = - "/" + newVersion + (remainingPath ? "/" + remainingPath : "/"); - }); - - header.appendChild(select); - }) - .catch((err) => { - console.error("Failed to load version selector:", err); - }); -})(); diff --git a/mkdocs.yml b/mkdocs.yml index 7288aef..79e161a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,9 +42,6 @@ markdown_extensions: - toc: permalink: true -extra_javascript: - - javascripts/version-selector.js - nav: - Home: index.md - Installation: installation.md diff --git a/scripts/deploy-docs.sh b/scripts/deploy-docs.sh index c59d0a0..194882a 100755 --- a/scripts/deploy-docs.sh +++ b/scripts/deploy-docs.sh @@ -5,21 +5,14 @@ source "$(dirname "${BASH_SOURCE[0]}")/lib/log.sh" source "$(dirname "${BASH_SOURCE[0]}")/lib/path.sh" readonly SITE="bolt.eugenetriguba.com" -readonly BUILD_DIR="${PATH_PROJECT_DIR}/site" -readonly VENV_DIR="${PATH_PROJECT_DIR}/.venv-docs" -readonly DOCS_REQUIREMENTS_FILE="${PATH_PROJECT_DIR}/docs/requirements-docs.txt" usage() { echo "Usage: $0" echo "" - echo "Build and deploy versioned documentation to SourceHut Pages" - echo "" - echo "Environment variables:" - echo " VERSION - The version to deploy (default: 'latest' for main branch)" + echo "Build and deploy documentation to SourceHut Pages" echo "" echo "Examples:" - echo " $0 # Deploy as 'latest'" - echo " VERSION=v1.0.0 $0 # Deploy as 'v1.0.0'" + echo " $0 # Build and deploy docs to $SITE" } main() { @@ -29,106 +22,27 @@ main() { fi log_header "Deploying Documentation" - - local version="${VERSION:-latest}" - log_info "Deploying version: $version" - - check_and_setup_docs_env - fetch_existing_site - build_version "$version" - update_versions_manifest + build_docs package_site - deploy_to_pages "$version" -} - -check_and_setup_docs_env() { - log_step "Checking documentation dependencies" - - if command -v mkdocs >/dev/null && python3 -m pip list | grep -q "mkdocs-material"; then - log_success "MkDocs dependencies found in system" - return 0 - fi - - log_info "MkDocs dependencies not found, setting up virtual environment" - if [[ ! -d "$VENV_DIR" ]]; then - log_step "Creating virtual environment" - python3 -m venv "$VENV_DIR" - log_success "Virtual environment created" - fi - - log_step "Activating virtual environment" - # shellcheck disable=SC1091 - source "$VENV_DIR/bin/activate" - log_step "Installing documentation dependencies" - pip install --requirement "${DOCS_REQUIREMENTS_FILE}" - log_success "Dependencies installed" -} - -fetch_existing_site() { - log_step "Fetching existing site" - mkdir -p "$BUILD_DIR" - - if hut pages download "$SITE" 2>/dev/null | tar -xzf - -C "$BUILD_DIR" 2>/dev/null; then - log_success "Existing site fetched" - else - log_info "No existing site found, starting fresh" - fi -} - -build_version() { - local version="$1" - log_step "Building documentation for version: $version" - - mkdocs build -d "$BUILD_DIR/$version" - - # If latest, also copy to root for default view - if [[ "$version" == "latest" ]]; then - log_step "Copying latest to root" - rsync -a --delete "$BUILD_DIR/latest/" "$BUILD_DIR/" \ - --exclude="versions.json" \ - --exclude="v*" \ - --exclude="latest" - fi - - log_success "Documentation built for $version" + deploy_to_pages } -update_versions_manifest() { - log_step "Updating versions manifest" - - local versions_json="[]" - if [[ -d "$BUILD_DIR/latest" ]]; then - versions_json=$(echo "$versions_json" | jq '. += [{"version": "latest", "title": "Latest (Development)"}]') - fi - - # Add all tagged versions (sorted in reverse) - if compgen -G "$BUILD_DIR/v*" >/dev/null; then - for dir in $(find "$BUILD_DIR" -maxdepth 1 -type d -name "v*" | sort -Vr); do - local ver - ver=$(basename "$dir") - versions_json=$(echo "$versions_json" | jq --arg v "$ver" '. += [{"version": $v, "title": $v}]') - done - fi - - jq -n --argjson versions "$versions_json" '{"versions": $versions}' >"$BUILD_DIR/versions.json" - - local version_count - version_count=$(echo "$versions_json" | jq 'length') - log_success "Versions manifest updated with $version_count version(s)" +build_docs() { + log_step "Building documentation with MkDocs" + mkdocs build + log_success "Documentation built successfully" } package_site() { log_step "Creating tarball" - tar -C "$BUILD_DIR" -czf site.tar.gz . + tar -C site -czf site.tar.gz . log_success "Site packaged as site.tar.gz" } deploy_to_pages() { - local version="$1" log_step "Deploying to SourceHut Pages: $SITE" hut pages publish -d "$SITE" site.tar.gz log_success "Documentation deployed to https://$SITE" - log_info "Version URL: https://$SITE/$version/" } main "$@" -- cgit v1.2.3