Merge branch 'docs/update_conf_common' into 'master'

Docs/update conf common

See merge request adf/esp-adf-internal!1339

Author: jason-mao

.gitlab-ci.yml

@@ -2,6 +2,7 @@ stages:
   - pre_check
   - build
   - target_test
+  - test_deploy
   - deploy
   - post_deploy
 

.gitlab/ci/docs.yml

@@ -11,6 +11,9 @@
 .patterns-docs-preview: &patterns-docs-preview
   - "docs/**/*"
 
+.if-schedule: &if-schedule
+  if: '$CI_PIPELINE_SOURCE == "schedule"'
+
 .if-merge_request_event: &if-merge_request_event
   if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
 
@@ -39,6 +42,8 @@
 
 .doc-rules:deploy:docs_production:
   rules:
+    - <<: *if-schedule
+      when: never
     - <<: *if-protected
 
 .before_script_install_requirements:
@@ -127,10 +132,12 @@ build_docs_pdf:
     - deploy-docs
 
 # stage: test_deploy
-.deploy_docs_preview:
+deploy_docs_preview:
   extends:
     - .deploy_docs_template
   rules:
+    - <<: *if-schedule
+      when: never
     - <<: *if-merge_request_event
     - <<: *if-open-merge-request
       when: never
@@ -141,12 +148,12 @@ build_docs_pdf:
       changes: *patterns-docs-preview
   variables:
     TYPE: "preview"
-    # older branches use DOCS_DEPLOY_KEY, DOCS_SERVER, DOCS_SERVER_USER, DOCS_PATH for preview server so we keep these names for 'preview'
-    DOCS_DEPLOY_PRIVATEKEY: "$DOCS_DEPLOY_KEY"
-    DOCS_DEPLOY_SERVER: "$DOCS_SERVER"
-    DOCS_DEPLOY_SERVER_USER: "$DOCS_SERVER_USER"
-    DOCS_DEPLOY_PATH: "$DOCS_PATH"
-    DOCS_DEPLOY_URL_BASE: "https://$DOCS_PREVIEW_SERVER_URL/docs/esp-adf"
+    # older branches use DOCS_PREVIEW_PRIVATEKEY, DOCS_PREVIEW_SERVER, DOCS_PREVIEW_SERVER_USER, DOCS_PATH for preview server so we keep these names for 'preview'
+    DOCS_DEPLOY_PRIVATEKEY: "$DOCS_PREVIEW_PRIVATEKEY"
+    DOCS_DEPLOY_SERVER: "$DOCS_PREVIEW_SERVER"
+    DOCS_DEPLOY_SERVER_USER: "$DOCS_PREVIEW_SERVER_USER"
+    DOCS_DEPLOY_PATH: "$DOCS_PREVIEW_PATH"
+    DOCS_DEPLOY_URL_BASE: "$DOCS_PREVIEW_URL_BASE"
 
 # stage: post_deploy
 deploy_docs_production:

README.md

@@ -1,6 +1,6 @@
 # Espressif Audio Development Framework
 
-[![Documentation Status](https://readthedocs.com/projects/espressif-esp-adf/badge/?version=latest)](https://docs.espressif.com/projects/esp-adf/en/latest/?badge=latest)
+[![Documentation Status](./docs/_static/doc_latest.svg)](https://docs.espressif.com/projects/esp-adf/en/latest/?badge=latest)
 
 Espressif Systems Audio Development Framework (ESP-ADF) is the official audio development framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview), [ESP32-S2](https://www.espressif.com/en/products/socs/esp32-s2), [ESP32-C3](https://www.espressif.com/en/products/socs/esp32-c3), [ESP32-C6](https://www.espressif.com/en/products/socs/esp32-c6), [ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3), and [ESP32-P4](https://www.espressif.com/en/products/socs/esp32-p4) SoCs.
 

docs/_static/doc_latest.svg

@@ -75,23 +75,6 @@
 master_doc = 'index'
 
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-
-# Readthedocs largely ignores 'version' and 'release', and displays one of
-# 'latest', tag name, or branch name, depending on the build type.
-# Still, this is useful for non-RTD builds.
-# This is supposed to be "the short X.Y version", but it's the only version
-# visible when you open index.html.
-# Display full version to make things less confusing.
-version = run_cmd_get_output('git describe')
-# The full version, including alpha/beta/rc tags.
-# If needed, nearest tag is returned by 'git describe --abbrev=0'.
-release = version
-print('Version: {0}  Release: {1}'.format(version, release))
-
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #today = ''