diff --git a/Dockerfile b/Dockerfile index b0811e854eb9fbb3122269890d9d4ba198c6e880..dafaf82a1eea503068a31141e8a55fb2de434152 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,3 +9,4 @@ RUN pip install sphinx_rtd_theme RUN apk add texlive-full RUN apk add make RUN apk add rsync +RUN apk add git diff --git a/VERSION b/VERSION index e3fd83d657efdb56f3bfe43765793001de96437e..53b8586e270675d1739b0fef2b7330aa78de0417 100644 --- a/VERSION +++ b/VERSION @@ -1,5 +1,5 @@ -VERSION_MAJOR = 0 +VERSION_MAJOR = 1 VERSION_MINOR = 0 -PATCHLEVEL = 9 -VERSION_TWEAK = 4 -EXTRAVERSION = +PATCHLEVEL = +VERSION_TWEAK = +EXTRAVERSION = wip diff --git a/_ext/callouts.py b/_ext/callouts.py index 8ed544aec52856f305cb501d9bfb2a2006ebb9d5..97bb23e4ee77d126cdac16d2e228987c6e31aa8a 100644 --- a/_ext/callouts.py +++ b/_ext/callouts.py @@ -47,7 +47,7 @@ class LiteralIncludeVisitor(nodes.NodeVisitor): source = str(node.rawsource) for i in range(1, 20): source = source.replace( - f"<{i}>", "``" + chr(int(f"0x{BASE_NUM + i}", base=16)) + "``" + f"<{i}>", chr(int(f"0x{BASE_NUM + i}", base=16)) ) node.rawsource = source node[:] = [nodes.Text(source)] diff --git a/conf.py b/conf.py index 431cc2611d207bb79a7e4e6a157a8b79ffb8cfd4..ccb08fdf2601122d6365332176079e6607433fed 100644 --- a/conf.py +++ b/conf.py @@ -133,7 +133,7 @@ html_context = { "pages_slug": pages_slug, "docs_url": docs_url, "current_version": version, - "versions": ("latest", "0.0", "0.1"), + "versions": ("latest", "0.0"), "reference_links": { "About": "https://beagleboard.org/about", "Donate": "https://beagleboard.org/donate", diff --git a/gitlab-build.sh b/gitlab-build.sh index 2ae2851cdf76f13b8e4078fead609137efa5b533..2325aa8f435b02c928b3dcbe0122e5b29dabe971 100755 --- a/gitlab-build.sh +++ b/gitlab-build.sh @@ -1,24 +1,35 @@ #!/bin/bash -env +apk add git +apk add rsync +apk add date + +export VER_LATEST_MAJOR=1 +export VER_LATEST_MINOR=0 +export VER_LATEST_EXTRA=wip +export PATCHLEVEL=$(date +%Y%m%d) +export VERSION_TWEAK=$(( $(date "+10#%H * 60 + 10#%M") )) -cat << EOF > PAGES -PAGES_URL = $CI_PAGES_URL -PAGES_SLUG = $CI_COMMIT_BRANCH -GITLAB_USER = $CI_PROJECT_NAMESPACE -PROJECT_BRANCH = $CI_COMMIT_BRANCH -GITLAB_HOST = $CI_SERVER_HOST -PROJECT_REPO = $CI_PROJECT_NAME +function do_build() { + cat << EOF > PAGES +PAGES_URL = $PAGES_URL +PAGES_SLUG = $PAGES_SLUG +GITLAB_USER = $GITLAB_USER +PROJECT_BRANCH = $PROJECT_BRANCH +GITLAB_HOST = $GITLAB_HOST +PROJECT_REPO = $PROJECT_REPO EOF -if [ "$CI_COMMIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]; then + cat << EOF > VERSION +VERSION_MAJOR = $VERSION_MAJOR +VERSION_MINOR = $VERSION_MINOR +PATCHLEVEL = $PATCHLEVEL +VERSION_TWEAK = $VERSION_TWEAK +EXTRAVERSION = $EXTRAVERSION +EOF -rm -rf public -sphinx-build -b html . public/latest/ -sphinx-build -M latexpdf . public/latest/ -mv public/latest/latex/beagleboard-docs.pdf public/latest/ -rm -rf public/latest/latex -cat <<HERE > public/index.html + mkdir -p public + cat <<HERE > public/index.html <!DOCTYPE html> <html> <head> @@ -30,47 +41,77 @@ cat <<HERE > public/index.html </html> HERE -elif [ "$CI_COMMIT_BRANCH" != "" ]; then + echo "**** Updating $PAGES_URL/$VER_DIR ****" -sphinx-build -b html . public/$CI_COMMIT_BRANCH/ -sphinx-build -M latexpdf . public/$CI_COMMIT_BRANCH/ -mv public/$CI_COMMIT_BRANCH/latex/beagleboard-docs.pdf public/$CI_COMMIT_BRANCH/ -rm -rf public/$CI_COMMIT_BRANCH/latex + sphinx-build -b html . public/$VER_DIR/ + sphinx-build -M latexpdf . public/$VER_DIR/ + mv public/$VER_DIR/latex/beagleboard-docs.pdf public/$VER_DIR/ + rm -rf public/$VER_DIR/latex -elif [ "$CI_COMMIT_TAG" != "" && "$CI_PROJECT_NAMESPACE" = "docs" ]; then + if [ "$CI_COMMIT_TAG" != "" ]; then + if [ "$VER_DIR" = "latest" ]; then + cp public/index.html /var/www/docs + fi + rsync -v -a --delete public/$VER_DIR/. /var/www/docs/$VER_DIR + fi +} -# Find which branch has the tag commit -export GIT_BRANCH=$(git branch -a --contains tags/$CI_COMMIT_TAG | grep origin | sed 's/.*origin\///') -cat << EOF > PAGES -PAGES_URL = $CI_PAGES_URL -PAGES_SLUG = $GIT_BRANCH -GITLAB_USER = $CI_PROJECT_NAMESPACE -PROJECT_BRANCH = $GIT_BRANCH -GITLAB_HOST = $CI_SERVER_HOST -PROJECT_REPO = $CI_PROJECT_NAME -EOF -if [ "$GIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]; then -export GIT_BRANCH=latest -rm -rf public -cat <<HERE > public/index.html -<!DOCTYPE html> -<html> - <head> - <meta http-equiv="refresh" content="0; url='latest/'" /> - </head> - <body> - <p>Please follow <a href="latest/">this link</a>.</p> - </body> -</html> -HERE -cp public/index.html /var/www/docs +if [ "$CI_COMMIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]; then + export VER_DIR=latest + export PAGES_URL=$CI_PAGES_URL + export PAGES_SLUG=$CI_COMMIT_BRANCH + export GITLAB_USER=$CI_PROJECT_NAMESPACE + export GITLAB_HOST=$CI_SERVER_HOST + export PROJECT_BRANCH=$CI_COMMIT_BRANCH + export PROJECT_REPO=$CI_PROJECT_NAME + export VERSION_MAJOR=$VER_LATEST_MAJOR + export VERSION_MINOR=$VER_LATEST_MINOR + export EXTRAVERSION=$VER_LATEST_EXTRA + do_build +elif [ "$CI_COMMIT_BRANCH" != "" ]; then + export VER_DIR=$CI_COMMIT_BRANCH + export PAGES_URL=$CI_PAGES_URL + export PAGES_SLUG=$CI_COMMIT_BRANCH + export GITLAB_USER=$CI_PROJECT_NAMESPACE + export GITLAB_HOST=$CI_SERVER_HOST + export PROJECT_BRANCH=$CI_COMMIT_BRANCH + export PROJECT_REPO=$CI_PROJECT_NAME + export BRANCH_VER=($(echo $CI_COMMIT_BRANCH | tr "." "\n")) + export VERSION_MAJOR=${BRANCH_VER[0]} + export VERSION_MINOR=${BRANCH_VER[1]} + export EXTRAVERSION=wip + do_build +elif [ "$CI_COMMIT_TAG" != "" ]; then + export TAG_SPLIT=($(echo $CI_COMMIT_TAG | tr "-" "\n")) + export TAG_VER=($(echo ${TAG_SPLIT[0]} | tr "." "\n")) + export VERSION_MAJOR=${TAG_VER[0]} + export VERSION_MINOR=${TAG_VER[1]} + export EXTRAVERSION=${TAG_SPLIT[1]} + export GIT_BRANCH=$(git branch -a --contains tags/$CI_COMMIT_TAG | grep origin | sed 's/.*origin\///') + if [ "$GIT_BRANCH" == "$CI_DEFAULT_BRANCH" ]; then + export VER_DIR=latest + export PAGES_URL=https://docs.beagleboard.org + export PAGES_SLUG=latest + export GITLAB_USER=docs + export GITLAB_HOST=$CI_SERVER_HOST + export PROJECT_BRANCH=$GIT_BRANCH + export PROJECT_REPO=docs.beagleboard.io + do_build + elif [ "$GIT_BRANCH" != "" ]; then + export VER_DIR=$GIT_BRANCH + export PAGES_URL=https://docs.beagleboard.org + export PAGES_SLUG=$GIT_BRANCH + export GITLAB_USER=docs + export GITLAB_HOST=$CI_SERVER_HOST + export PROJECT_BRANCH=$GIT_BRANCH + export PROJECT_REPO=docs.beagleboard.io + do_build + else + echo "***** Branch not found for tag *****" + fi +else + echo "***** Not on a branch or tag *****" fi -sphinx-build -b html . public/$GIT_BRANCH/ -sphinx-build -M latexpdf . public/$GIT_BRANCH/ -cp public/$GIT_BRANCH/latex/beagleboard-docs.pdf public/$GIT_BRANCH/beagleboard-docs-$CI_COMMIT_TAG.pdf -cp public/$GIT_BRANCH/latex/beagleboard-docs.pdf public/$GIT_BRANCH/beagleboard-docs.pdf -rm -rf public/$GIT_BRANCH/latex -sudo apk add rsync -rsync -a --delete public/$GIT_BRANCH/. /var/www/docs/$GIT_BRANCH -fi +env + diff --git a/index.rst b/index.rst index c2f9daf399ce92d131ec2f2dcf5d216f3fa001ed..6c3f25c55edc13ae243a5bbfe3d0444067f81946 100644 --- a/index.rst +++ b/index.rst @@ -54,7 +54,7 @@ from source using appropriate design tools. :gutter: 4 .. grid-item-card:: - :link: beagleboneblack-home + :link: bbai64-home :link-type: ref **BeagleBone® AI-64** diff --git a/intro/index.rst b/intro/index.rst index 22fbdbc77802da87f94fcaa1e63460a6700d0d50..8001002d4a5959de10a5989b680e70d44a462bd2 100644 --- a/intro/index.rst +++ b/intro/index.rst @@ -6,6 +6,11 @@ Introduction Welcome to the BeagleBoard documentation project. If you are looking for help with your Beagle open-hardware development platform, you've found the right place! +For the latest versions of this documentation, be sure to check the official release sites: + +* https://docs.beagle.cc (cached with local proxies) +* https://docs.beagleboard.org (non-cached, without proxies) + Please check out our :ref:`support` page` to find out how to get started, resolve issues, and engage the developer community.