feat(mkdocs): add black for mkdocstrings to format signature

ref: https://github.com/nofusscomputing/centurion_erp/pull/776

automation/.gitlab-ci-ansible.yaml

@@ -6,7 +6,7 @@ include:
 
 
 .ansible_playbook:
-  image: 
+  image:
     name: nofusscomputing/ansible-ee:dev
     pull_policy: always
   stage: chores
@@ -21,7 +21,10 @@ include:
     - echo "[DEBUG] ansible_inventory=$ansible_inventory"
     - echo "[DEBUG] ansible_playbook=$ansible_playbook"
     - echo "[DEBUG] ansible_tags=$ansible_tags"
-    - ansible-playbook $ansible_inventory $ANSIBLE_PLAYBOOK_DIR/$ansible_playbook $ansible_tags -vvv
+    - echo "[TRACE] ********************************** start ******************************************"
+    - export
+    - echo "[TRACE] *********************************** end *******************************************"
+    - ansible-playbook $ansible_inventory $ANSIBLE_PLAYBOOK_DIR/$ansible_playbook $ansible_tags --extra-vars "nfc_pb_host=localhost" -vvv
   rules:
   # ToDo: at some stage redefine these rules so that the job can run if specified.
     # - if: '$NFC_AUTO_JOBS == "false"'

docker/build.gitlab-ci.yaml

@@ -56,15 +56,20 @@ variables:
     - update-binfmts --display
     - |
 
+      if [ "0$NFC_IMAGE_DESCRIPTION" != "0" ]; then NFC_IMAGE_DESCRIPTION=${NFC_IMAGE_DESCRIPTION}; else NFC_IMAGE_DESCRIPTION="No Fuss Computing Image"; fi;
+
       if [ "0$DOCKER_IMAGE_BUILD_TARGET_PLATFORMS" != "0" ]; then
 
         echo "[DEBUG] building multiarch/specified arch image";
 
         docker buildx build --platform=$DOCKER_IMAGE_BUILD_TARGET_PLATFORMS . \
-          --label org.opencontainers.image.created="$(date '+%Y-%m-%d %H:%M:%S%:z')" \
+          --label org.opencontainers.image.created="$(date '+%Y-%m-%dT%H:%M:%S%:z')" \
+          --label org.opencontainers.image.description="$NFC_IMAGE_DESCRIPTION" \
           --label org.opencontainers.image.documentation="$CI_PROJECT_URL" \
           --label org.opencontainers.image.source="$CI_PROJECT_URL" \
           --label org.opencontainers.image.revision="$CI_COMMIT_SHA" \
+          --label io.artifacthub.package.readme-url="$CI_PROJECT_URL/-/raw/development/README.md?ref_type=heads" \
+          --label io.artifacthub.package.maintainers='[{"name":"No Fuss Computing","email":"helpdesk@nofusscomputing.com"}]' \
         --push \
         --build-arg CI_JOB_TOKEN=$CI_JOB_TOKEN --build-arg CI_PROJECT_ID=$CI_PROJECT_ID --build-arg CI_API_V4_URL=$CI_API_V4_URL \
         --file $DOCKER_DOCKERFILE \
@@ -73,7 +78,7 @@ variables:
         docker buildx imagetools inspect $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG;
 
         # during docker multi platform build there are >=3 additional unknown images added to gitlab container registry. cleanup
-        
+
         DOCKER_MULTI_ARCH_IMAGES=$(docker buildx imagetools inspect "$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG" --format "{{ range .Manifest.Manifests }}{{ if ne (print .Platform) \"&{unknown unknown  [] }\" }}$DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG@{{ println .Digest }}{{end}} {{end}}");
 
         docker buildx imagetools create $DOCKER_MULTI_ARCH_IMAGES --tag $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG;
@@ -85,16 +90,19 @@ variables:
         echo "[DEBUG] building image";
 
         docker build . \
-          --label org.opencontainers.image.created="$(date '+%Y-%m-%d %H:%M:%S%:z')" \
+          --label org.opencontainers.image.created="$(date '+%Y-%m-%dT%H:%M:%S%:z')" \
+          --label org.opencontainers.image.description="$NFC_IMAGE_DESCRIPTION" \
           --label org.opencontainers.image.documentation="$CI_PROJECT_URL" \
           --label org.opencontainers.image.source="$CI_PROJECT_URL" \
           --label org.opencontainers.image.url="$CI_PROJECT_URL/-/releases/$(cz -n cz_nfc version --project)" \
           --label org.opencontainers.image.version="$(cz -n cz_nfc version --project)" \
           --label org.opencontainers.image.revision="$CI_COMMIT_SHA" \
+          --label io.artifacthub.package.readme-url="$CI_PROJECT_URL/-/raw/development/README.md?ref_type=heads" \
+          --label io.artifacthub.package.maintainers='[{"name":"No Fuss Computing","email":"helpdesk@nofusscomputing.com"}]' \
         --build-arg CI_JOB_TOKEN=$CI_JOB_TOKEN --build-arg CI_PROJECT_ID=$CI_PROJECT_ID --build-arg CI_API_V4_URL=$CI_API_V4_URL \
         --file $DOCKER_DOCKERFILE \
         --tag $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG;
-      
+
       docker push $DOCKER_IMAGE_BUILD_REGISTRY/$DOCKER_IMAGE_BUILD_NAME:$DOCKER_IMAGE_BUILD_TAG;
 
       fi

mkdocs/requirements.txt

@@ -1,6 +1,10 @@
+# MkDocs: show_signature_annotations=True
+black==25.1.0
+
 mkdocs==1.5.3
 mkdocstrings==0.25.1
 mkdocstrings-python==1.10.3
+mkdocs-autorefs==1.3.1
 mkdocs-minify-plugin==0.8.0
 mkdocs-material-extensions==1.3.1
 wheel
@@ -9,3 +13,4 @@ mkdocs-material==9.5.6
 mkdocs-git-revision-date-localized-plugin==1.2.2
 pymdown-extensions==10.7
 Jinja2==3.1.3
+griffe==0.49.0