Merge pull request #196 from compas-dev/doc_versions

Doc versioning

Author: gonzalocasas

.bumpversion.cfg

@@ -8,6 +8,11 @@ tag = True
 search = version = release = '{current_version}'
 replace = version = release = '{new_version}'
 
+[bumpversion:file:docs/doc_versions.txt]
+search = {current_version}
+replace = {new_version}
+	{current_version}
+
 [bumpversion:file:src/compas_fab/__version__.py]
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'

.github/workflows/docs.yml

@@ -25,14 +25,27 @@ jobs:
       - name: Install
         run: |
           python -m pip install --no-cache-dir -r requirements-dev.txt
-      - name: Get branch/tag name
-        id: get-branch
-        uses: ypicard/get-branch-name-github-action@v1
       - name: Generate docs
         if: ${{ success() }}
         run: |
           invoke docs
-          mkdir -p deploy/compas_fab/${{ steps.get-branch.outputs.tag }} && mv -T dist/docs deploy/compas_fab/${{ steps.get-branch.outputs.tag }}/
+
+          # Get branch/tag/latest name from git
+          GITHUB_REF_REGEX="tags/([0-9a-zA-Z\.\-]+)|(pull/[0-9]+)|heads/(.+)"
+
+          if [[ $GITHUB_REF =~ $GITHUB_REF_REGEX ]]; then
+            if [[ $BASH_REMATCH = pull* ]]; then
+              BRANCH_OR_TAG=pull_${BASH_REMATCH##*/}
+            else
+              BRANCH_OR_TAG=${BASH_REMATCH##*/}
+            fi;
+            if [[ $BRANCH_OR_TAG = master ]]; then
+              BRANCH_OR_TAG=latest
+            fi;
+          fi;
+
+          echo "Docs will be deployed to https://gramaziokohler.github.io/compas_fab/$BRANCH_OR_TAG"
+          mkdir -p deploy/compas_fab/$BRANCH_OR_TAG && mv -T dist/docs deploy/compas_fab/$BRANCH_OR_TAG/
       - name: Deploy docs
         if: success()
         uses: crazy-max/ghaction-github-pages@v2

docs/conf.py

@@ -59,6 +59,14 @@
 # autosummary options
 autosummary_generate = True
 
+# collect doc versions
+package_docs_root = 'https://gramaziokohler.github.io/compas_fab/'
+
+with open(os.path.join(os.path.dirname(__file__), 'doc_versions.txt'), 'r') as f:
+    version_names = [version.strip() for version in f.readlines()]
+    package_docs_versions = [(version, '{}{}'.format(package_docs_root, version))
+                             for version in version_names if version]
+
 # on_rtd is whether we are on readthedocs.org
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 html_theme = 'compaspkg'
@@ -68,6 +76,8 @@
     "package_title": project,
     "package_version": release,
     "package_repo": 'https://github.com/compas-dev/compas_fab',
+    "package_docs": package_docs_root,
+    "package_old_versions": package_docs_versions
 }
 
 html_split_index = False

docs/doc_versions.txt

@@ -0,0 +1,6 @@
+latest
+stable
+0.11.0
+0.10.1
+0.10.0
+0.1.0

requirements-dev.txt

@@ -1,8 +1,8 @@
 attrs>=19.3.0
-sphinx_compas_theme>=0.4
+sphinx_compas_theme>=0.9
 sphinx>=1.6
 invoke>=0.14
-bump2version>=0.5.11
+bump2version>=1.0
 check-manifest>=0.36
 flake8
 autopep8