From e62985c55dbc6c049036e88e08f896fe1f990f01 Mon Sep 17 00:00:00 2001 From: aleks Date: Mon, 19 Jun 2023 16:14:31 +0200 Subject: [PATCH] fix component documentation --- .gitlab-ci.yml | 2 +- docs/_static/modbus_docs_versions.js | 7 +------ docs/conf_common.py | 2 +- docs/generate_docs | 27 +++++++++++++++++++++++++++ 4 files changed, 30 insertions(+), 8 deletions(-) create mode 100755 docs/generate_docs diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 445faf1..b887798 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -194,7 +194,7 @@ build_docs: script: - cd docs - pip install -r requirements.txt - - build-docs -l en -t esp32 + - ./generate_docs .deploy_docs_template: stage: deploy diff --git a/docs/_static/modbus_docs_versions.js b/docs/_static/modbus_docs_versions.js index 9325dc4..37a2cda 100644 --- a/docs/_static/modbus_docs_versions.js +++ b/docs/_static/modbus_docs_versions.js @@ -1,11 +1,6 @@ var DOCUMENTATION_VERSIONS = { - DEFAULTS: { has_targets: true, - supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2" ] - }, VERSIONS: [ - { name: "latest" }, - { name: "v1.0.10", old:false }, - { name: "v1.0.0", old:true } + { name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2" ] }, ], IDF_TARGETS: [ { text: "ESP32", value: "esp32"}, diff --git a/docs/conf_common.py b/docs/conf_common.py index fcd437e..9e090d1 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -29,5 +29,5 @@ html_static_path = ['../_static'] project_slug = 'esp-modbus' versions_url = './_static/modbus_docs_versions.js' -idf_targets = [ 'esp32', 'esp32s2', 'esp32s3', 'esp32c2', 'esp32c3', 'esp32c6', 'esp32h2' ] +idf_targets = [ 'esp32' ] languages = ['en'] diff --git a/docs/generate_docs b/docs/generate_docs new file mode 100755 index 0000000..d9af465 --- /dev/null +++ b/docs/generate_docs @@ -0,0 +1,27 @@ +#!/bin/bash + +rm -rf docs +build-docs --target esp32 --language en + +# Modifes target field of html files +ELEMENT="" + +FILES=$(find . -path "*/_build/en/esp32/html/*.html") + +for FILE in ${FILES} + do + echo ${ELEMENT} >> "${FILE}" + done + +