From 7af1fac17092dd34af166edf1f8259ea51a06713 Mon Sep 17 00:00:00 2001 From: Mike Date: Mon, 25 Mar 2024 14:57:21 +0000 Subject: [PATCH] Update CI action versions, readthedocs (#2743) This PR updates github action versions as some are now deprecated and cause build errors. Everything now builds against ubuntu-22.04. Sphinx has been updated from 4.2.0 to current 7.2.6 release. Noted that with Sming 5.1 seqdiag is broken (on https://sming.readthedocs.io/en/latest/information/tasks.html) because of pillow; downgrading to 9.5.0 fixes this. Also included are some minor documentation fixes. --- .github/workflows/codeql-analysis.yml | 8 +++---- .github/workflows/coverity-scan.yml | 4 ++-- .github/workflows/release.yml | 2 +- .github/workflows/spelling-check.yml | 2 +- .readthedocs.yml | 4 ++-- Sming/Arch/Esp32/Components/driver/pwm.rst | 21 ------------------- .../Arch/Host/Components/esp_wifi/README.rst | 2 +- Sming/Arch/Host/Components/hostlib/README.rst | 2 +- Sming/Components/Network/telnet.rst | 8 ++----- docs/requirements.txt | 13 ++++++------ docs/source/information/develop/ci.rst | 2 +- docs/source/upgrading/index.rst | 1 + 12 files changed, 22 insertions(+), 47 deletions(-) delete mode 100644 Sming/Arch/Esp32/Components/driver/pwm.rst diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index da50404adc..3b56ecb4f0 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -17,7 +17,7 @@ on: jobs: analyze: name: Analyze - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest strategy: fail-fast: false @@ -30,7 +30,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: # We must fetch at least the immediate parents so that if this is # a pull request then we can checkout the head. @@ -38,7 +38,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v1 + uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -67,4 +67,4 @@ jobs: make -j3 SMING_ARCH=Host - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/coverity-scan.yml b/.github/workflows/coverity-scan.yml index 10287b0e53..21b710e246 100644 --- a/.github/workflows/coverity-scan.yml +++ b/.github/workflows/coverity-scan.yml @@ -18,11 +18,11 @@ jobs: # group: ${{ github.head_ref || github.run_id }} # cancel-in-progress: true - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Check if we are allowed to scan env: BRANCH: ${{github.ref_name}} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 06cf230995..6eb7520fce 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -12,7 +12,7 @@ jobs: release: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: trstringer/manual-approval@v1 if: ${{ github.ref_type == 'tag' }} with: diff --git a/.github/workflows/spelling-check.yml b/.github/workflows/spelling-check.yml index 4e8d27e7be..9d3a76dba8 100644 --- a/.github/workflows/spelling-check.yml +++ b/.github/workflows/spelling-check.yml @@ -10,7 +10,7 @@ jobs: name: Check spelling runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: submodules: false - name: Get submodules diff --git a/.readthedocs.yml b/.readthedocs.yml index fa3b0a80e9..13b0003085 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -7,9 +7,9 @@ version: 2 # Required build: - os: ubuntu-20.04 + os: ubuntu-22.04 tools: - python: "3.8" + python: "3.12" # Optionally build your docs in additional formats such as PDF and ePub formats: diff --git a/Sming/Arch/Esp32/Components/driver/pwm.rst b/Sming/Arch/Esp32/Components/driver/pwm.rst deleted file mode 100644 index 47df1eb558..0000000000 --- a/Sming/Arch/Esp32/Components/driver/pwm.rst +++ /dev/null @@ -1,21 +0,0 @@ -PWM: Pulse-Width Modulation -=========================== - -The driver interface is defined in the ESP8266 SDK. - -Build variables ---------------- - -.. envvar:: ENABLE_CUSTOM_PWM - - undefined - use the Espressif PWM driver - - 1 (default) - Use the *New PWM* driver, a drop-in replacement for the version provided in the Espressif SDK. - -API Documentation ------------------ - -.. doxygengroup:: pwm_driver - :content-only: diff --git a/Sming/Arch/Host/Components/esp_wifi/README.rst b/Sming/Arch/Host/Components/esp_wifi/README.rst index 18270f816d..f13ef4ccde 100644 --- a/Sming/Arch/Host/Components/esp_wifi/README.rst +++ b/Sming/Arch/Host/Components/esp_wifi/README.rst @@ -1,4 +1,4 @@ Host WiFi ========= -Provides WiFi / network functions. The actual implementations are provided in :component-host:`lwip` +Provides WiFi / network functions. The actual implementations are provided in :component:`lwip` diff --git a/Sming/Arch/Host/Components/hostlib/README.rst b/Sming/Arch/Host/Components/hostlib/README.rst index 55716d30db..3e6f37db68 100644 --- a/Sming/Arch/Host/Components/hostlib/README.rst +++ b/Sming/Arch/Host/Components/hostlib/README.rst @@ -17,7 +17,7 @@ the :cpp:class:`CommandLine`. Startup ------- -Initialises :component-host:`spi_flash`, Uart server (in :component-host:`driver`) and :component-host:`lwip` +Initialises :component-host:`spi_flash`, Uart server (in :component-host:`driver`) and :component:`lwip` networking, then enters the main task loop. This loop services LWIP plus the task and timer queues (implemented in :component-host:`esp_hal`). The ``Ctrl+C`` keypress is trapped to provide an orderly exit. If the system has become stuck in a loop or is otherwise diff --git a/Sming/Components/Network/telnet.rst b/Sming/Components/Network/telnet.rst index 4ab02098fe..108342a335 100644 --- a/Sming/Components/Network/telnet.rst +++ b/Sming/Components/Network/telnet.rst @@ -3,9 +3,5 @@ Telnet https://en.m.wikipedia.org/wiki/Telnet -Server API ----------- - -.. doxygengroup:: telnetserver - :content-only: - :members: +This is a very simple protocol which can be implemented using a :cpp:class:`TcpServer` class. +See :sample:`TelnetServer` for an example application. diff --git a/docs/requirements.txt b/docs/requirements.txt index f731a1c431..0c9339c546 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,13 +1,12 @@ # Requirements file for pip # list of Python packages used in documentation build -sphinx==4.2.0 -sphinx-rtd-theme==1.0.0 -m2r2==0.3.2 -# mistune==2.0.3 # Version 2 not compatible with m2r2 -breathe==4.31.0 +sphinx==7.2.6 +sphinx-rtd-theme==2.0.0 +m2r2==0.3.3.post2 +breathe==4.35.0 sphinxcontrib-wavedrom sphinx-copybutton -sphinxcontrib-seqdiag==2.0.0 +sphinxcontrib-seqdiag jinja2>=3.0.3 setuptools>=57.5.0 -funcparserlib==1.0.0a0 +pillow==9.5.0 # V10 breaks seqdiag diff --git a/docs/source/information/develop/ci.rst b/docs/source/information/develop/ci.rst index 30062b52d0..4c55e692d2 100644 --- a/docs/source/information/develop/ci.rst +++ b/docs/source/information/develop/ci.rst @@ -120,7 +120,7 @@ Set ``Project URL slug`` For example, testing the ``Sming-jerryscript`` library requires this value to be set to ``jerryscript`` to match the Sming library name. - Build logs should then report a warning ``Multiple matches found for Component 'jerryscript'. + Build logs should then report a warning ``Multiple matches found for Component 'jerryscript'``. Set sming fork/branch By default builds use the main Sming ``develop`` branch. diff --git a/docs/source/upgrading/index.rst b/docs/source/upgrading/index.rst index 9677ddf287..a0e3ace2a7 100644 --- a/docs/source/upgrading/index.rst +++ b/docs/source/upgrading/index.rst @@ -7,6 +7,7 @@ For newer versions we have dedicated pages. .. toctree:: :maxdepth: 1 + 5.1-5.2 4.7-5.1 4.6-4.7 4.5-4.6