Skip to content

Commit

Permalink
Update CI action versions, readthedocs (#2743)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mikee47 authored Mar 25, 2024
1 parent 629678a commit 7af1fac
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 47 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ on:
jobs:
analyze:
name: Analyze
runs-on: ubuntu-20.04
runs-on: ubuntu-latest

strategy:
fail-fast: false
Expand All @@ -30,15 +30,15 @@ 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.
fetch-depth: 2

# 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.
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions .github/workflows/coverity-scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spelling-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
21 changes: 0 additions & 21 deletions Sming/Arch/Esp32/Components/driver/pwm.rst

This file was deleted.

2 changes: 1 addition & 1 deletion Sming/Arch/Host/Components/esp_wifi/README.rst
Original file line number Diff line number Diff line change
@@ -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`
2 changes: 1 addition & 1 deletion Sming/Arch/Host/Components/hostlib/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 2 additions & 6 deletions Sming/Components/Network/telnet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 6 additions & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/source/information/develop/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/source/upgrading/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7af1fac

Please sign in to comment.