diff --git a/docs/_static/choose_language.png b/docs/_static/choose_language.png new file mode 100644 index 0000000000..9b24c1faa9 Binary files /dev/null and b/docs/_static/choose_language.png differ diff --git a/docs/_static/choose_version.png b/docs/_static/choose_version.png index c8927df118..ad479c7fd9 100644 Binary files a/docs/_static/choose_version.png and b/docs/_static/choose_version.png differ diff --git a/docs/_static/js/version_table.js b/docs/_static/js/version_table.js new file mode 100644 index 0000000000..5e0c4cba58 --- /dev/null +++ b/docs/_static/js/version_table.js @@ -0,0 +1,54 @@ +$(document).ready(function() { + + let version = DOCUMENTATION_OPTIONS.VERSION; + let language = DOCUMENTATION_OPTIONS.LANGUAGE; + let idf_target = DOCUMENTATION_OPTIONS.IDF_TARGET; + let pagename = DOCUMENTATION_OPTIONS.PAGENAME + ".html"; + + let defaults = DOCUMENTATION_VERSIONS.DEFAULTS; + let versions = DOCUMENTATION_VERSIONS.VERSIONS; + + /* Apply the defaults to each version, where needed */ + for (let i = 0; i < versions.length; i++) { + let v = versions[i]; + for (let d in defaults) { + if (!(d in v)) { + v[d] = defaults[d]; + } + } + } + + /* Find the (relative) base URL for this project, finding a sibling URL will be built as follows: + /// + + (Where 'idf_target' path element are optional depending on if the project has multiple target support) + */ + let project_base_url = DOCUMENTATION_OPTIONS.URL_ROOT + "../../.."; + if (DOCUMENTATION_OPTIONS.IDF_TARGETS) { + project_base_url += "/.."; + } + + /* Given a version from the list, return the URL to link to it */ + function getVersionUrl(v) { + let result = project_base_url + "/" + language + "/" + v.name; + if (v.has_targets) { + result += "/" + (idf_target || "esp32"); + } + + return result + "/"; + }; + + old_ver_list = ""; + + for (let i = 0; i < versions.length; i++) { + let v = versions[i]; + let url = getVersionUrl(v); + + if (v.old) { + old_ver_list += "
  • " + v.name + "
  • "; + } + + } + + $( "#version_list" ).append(old_ver_list); +}); diff --git a/docs/_static/version_table.html b/docs/_static/version_table.html new file mode 100644 index 0000000000..6e0feedbbe --- /dev/null +++ b/docs/_static/version_table.html @@ -0,0 +1,7 @@ + + + +
      + +
    +
    diff --git a/docs/en/index.rst b/docs/en/index.rst index 547c663db2..a2731a9518 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -6,7 +6,7 @@ This is the documentation for Espressif IoT Development Framework (`esp-idf