Removed the version and target selection for now

espressif · Dec 7, 2023 · a19317b · a19317b
1 parent 4b94ead
commit a19317b
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 45 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -36,7 +36,7 @@ jobs:
         # Update the path to include them and run.
         cd ./docs
         PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
-        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en -t esp32 esp32s2 esp32s3 esp32c6 esp32h2
+        PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
     - name: Archive Docs
       uses: actions/upload-artifact@v2
       with:

diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml
@@ -1,16 +1,15 @@
 name: Documentation Deploy CI
 
+// Deploy to production on each merge to master
 on:
-  workflow_dispatch:
-  release:
-    types:
-      - created
+  push:
+    branches:
+      - master
     paths:
     - 'docs/**'
     - '.github/workflows/docs_deploy.yml'
 
 jobs:
-
   deploy-preview-docs:
     name: Deploy Documentation
     runs-on: ubuntu-22.04
@@ -26,8 +25,16 @@ jobs:
         python-version: '3.10'
     - name: Deploy Preview
       env:
+        # Deploy to production server
+        # DOCS_BUILD_DIR: "./docs/_build/"
+        # DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }}
+        # DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
+        # DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_SERVER_USER }}
+        # DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
+        # DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
+        # Deploy to preview server
         DOCS_BUILD_DIR: "./docs/_build/"
-        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_DEPLOY_KEY }}
+        DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PREV_DEPLOY_KEY }}
         DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PREV_SERVER }}
         DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PREV_SERVER_USER }}
         DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PREV_PATH }}

diff --git a/docs/_static/arduino_versions.js b/docs/_static/arduino_versions.js
@@ -4,16 +4,6 @@ var DOCUMENTATION_VERSIONS = {
               },
     VERSIONS: [
       { name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3", "esp32h2", "esp32c6"  ] },
-      // 2.0.14
-      { name: "release-3.0.0-alpha1", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3", "esp32h2", "esp32c6"  ] },
-      // 2.0.14
-      { name: "release-3.0.0-alpha1", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3", "esp32h2", "esp32c6"  ] },
-      // 2.0.14
-      { name: "release-3.0.0-alpha1", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3", "esp32h2", "esp32c6"  ] },
-      // 2.0.14
-      { name: "release-2.0.14", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3" ] },
-      // 2.0.13
-      { name: "release-2.0.13", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3" ] },
     ],
     IDF_TARGETS: [
        { text: "ESP32", value: "esp32"},

diff --git a/docs/conf_common.py b/docs/conf_common.py
@@ -4,14 +4,14 @@
 
 languages = ["en"]
 
-idf_targets = [
-    "esp32",
-    "esp32s2",
-    "esp32s3",
-    "esp32c3",
-    "esp32c6",
-    "esp32h2",
-]
+# idf_targets = [
+#     "esp32",
+#     "esp32s2",
+#     "esp32s3",
+#     "esp32c3",
+#     "esp32c6",
+#     "esp32h2",
+# ]
 
 # link roles config
 github_repo = "espressif/arduino-esp32"
@@ -29,26 +29,26 @@
                'esp_docs.esp_extensions.dummy_build_system',
                ]
 
-ESP32_DOCS = [
-    "index.rst",
-]
-
-ESP32S2_DOCS = ESP32_DOCS
-ESP32C3_DOCS = ESP32S2_DOCS
-ESP32S3_DOCS = ESP32S2_DOCS
-ESP32C6_DOCS = ESP32S2_DOCS
-ESP32H2_DOCS = ESP32S2_DOCS
-
-conditional_include_dict = {
-    "esp32": ESP32_DOCS,
-    "esp32s2": ESP32S2_DOCS,
-    "esp32c3": ESP32C3_DOCS,
-    "esp32s3": ESP32S3_DOCS,
-    "esp32c6": ESP32C6_DOCS,
-    "esp32h2": ESP32H2_DOCS,
-}
+# ESP32_DOCS = [
+#     "index.rst",
+# ]
+
+# ESP32S2_DOCS = ESP32_DOCS
+# ESP32C3_DOCS = ESP32S2_DOCS
+# ESP32S3_DOCS = ESP32S2_DOCS
+# ESP32C6_DOCS = ESP32S2_DOCS
+# ESP32H2_DOCS = ESP32S2_DOCS
+
+# conditional_include_dict = {
+#     "esp32": ESP32_DOCS,
+#     "esp32s2": ESP32S2_DOCS,
+#     "esp32c3": ESP32C3_DOCS,
+#     "esp32s3": ESP32S3_DOCS,
+#     "esp32c6": ESP32C6_DOCS,
+#     "esp32h2": ESP32H2_DOCS,
+# }
 
 # Extra options required by sphinx_idf_theme
 project_slug = "arduino-esp32"
 
-versions_url = "./_static/arduino_versions.js"
+# versions_url = "./_static/arduino_versions.js"
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -2,7 +2,7 @@
 Welcome to Arduino Core's documentation
 #######################################
 
-Here you will find all the relevant information about the project based on the {IDF_TARGET_NAME}.
+Here you will find all the relevant information about the project based on the Arduino Core ESP32.
 
 .. note::
    This is a work in progress documentation and we will appreciate your help! We are looking for contributors!