Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
Commit 65bf078f authored by Deepak Khatri's avatar Deepak Khatri :dog:
Browse files

Merge changes from Jason 

commit 11364bf5
Author: Jason Kridner <jkridner@beagleboard.org>
Date:   Fri Sep 30 10:06:24 2022 -0400

    We are releasing 0.0 and starting work on 1.0, yes?

commit 82ad6b70
Merge: 78a5c328 23cbaef2
Author: Jason Kridner <jkridner@beagleboard.org>
Date:   Thu Sep 29 22:27:34 2022 -0400

    Merge branch '0.0' into 'main'

    Fixes for gitlab-build.sh when tag is not on branch

    See merge request jkridner/docs.beagleboard.io!3

commit 23cbaef2
Author: Jason Kridner <jkridner@beagleboard.org>
Date:   Thu Sep 29 22:27:34 2022 -0400

    Fixes for gitlab-build.sh when tag is not on branch

commit 78a5c328
Author: Jason Kridner <jkridner@beagleboard.org>
Date:   Thu Sep 29 15:22:25 2022 -0400

    Versioning proposal

    * I believe our next release should be considered 1.0. Only major
      releases should make incompatible URLs and I believe we should...
parent 01ca5277
1 merge request!37Making Additional References and Text to My Previous Merge
Pipeline #965 passed with stage
Stage:
    in 6 minutes and 47 seconds
    Hide whitespace changes
    Inline Side-by-side
    Dockerfile
    + 1
    − 0
    View file @ 65bf078f
    ......@@ -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
    VERSION
    + 4
    − 4
    View file @ 65bf078f
    VERSION_MAJOR = 0
    VERSION_MAJOR = 1
    VERSION_MINOR = 0
    PATCHLEVEL = 9
    VERSION_TWEAK = 4
    EXTRAVERSION =
    PATCHLEVEL =
    VERSION_TWEAK =
    EXTRAVERSION = wip
    _ext/callouts.py
    + 1
    − 1
    View file @ 65bf078f
    ......@@ -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)]
    ......
    conf.py
    + 1
    − 1
    View file @ 65bf078f
    ......@@ -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",
    ......
    gitlab-build.sh
    + 95
    − 54
    View file @ 65bf078f
    #!/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
    index.rst
    + 1
    − 1
    View file @ 65bf078f
    ......@@ -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**
    ......
    intro/index.rst
    + 5
    − 0
    View file @ 65bf078f
    ......@@ -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.
    ......
    0% or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment

    Open hardware computers for makers, educators and professionals