Fix CI, Docker Files, and Documentation Workflow (#100)

* Hotfix documentations and enable manual documentation build.

* Fix broken Docker file

* Fix breaking change and missing dependency

* Adapt wrong instruction in README

* Try to reduce disk usage

* Try to reduce disk usage of building container

* Adjust changelog

* Fix formatting

* Implement PR feedback

Author: Xeratec

.github/workflows/BuildDockerDeeploy.yml

@@ -51,6 +51,7 @@ jobs:
       - name: Free up disk space
         uses: jlumbroso/free-disk-space@v1.3.1
         with:
+          tool-cache: true
           android: true
           dotnet: true
           haskell: true

.github/workflows/documentation.yml

@@ -1,6 +1,9 @@
 name: documentation
 
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
 
 permissions:
   contents: write
@@ -13,7 +16,7 @@ jobs:
       - uses: actions/setup-python@v5
       - name: Install dependencies
         run: |
-          pip install numpy mako onnx_graphsurgeon ortools sphinx sphinx_rtd_theme myst_parser
+          pip install numpy mako onnx_graphsurgeon ortools sphinx sphinx_rtd_theme myst-parser[linkify] sphinx_favicon
       - name: Sphinx build
         run: |
           sphinx-build docs _build

CHANGELOG.md

@@ -5,6 +5,7 @@ This file contains the changelog for the Deeploy project. The changelog is divid
 This release containing major architectural changes, new platform support, enhanced simulation workflows, floating-point kernel support, training infrastructure for CCT models, memory allocation strategies, and documentation improvements.
 
 ### List of Pull Requests
+- Fix CI, Docker Files, and Documentation Workflow [#100](https://github.com/pulp-platform/Deeploy/pull/100)
 - Chimera Platform Integration [#96](https://github.com/pulp-platform/Deeploy/pull/96)
 - Add Tutorial and Refactor README [#97](https://github.com/pulp-platform/Deeploy/pull/97)
 - Reduce Mean Float Template [#92](https://github.com/pulp-platform/Deeploy/pull/92)

Container/Dockerfile.deeploy

@@ -21,17 +21,19 @@ COPY Makefile ./
 COPY requirements-dev.txt ./
 
 # Compile emulators
-RUN apt-get upgrade && \
-    apt-get update && \
-    apt-get install -y python3.10-venv \
-    python3.10-distutils 
-
+# WIESEP: We need to already clean up some space, otherwise the GitHub runners run out of disk space
 RUN --mount=type=cache,target=/ccache \
     ccache -z && \
     make pulp-sdk chimera-sdk qemu mempool banshee xtensor && \
     make gvsoc && \
     cp -r /app/toolchain/gvsoc/core/requirements.txt /app/core-requirements.txt && \
     cp -r /app/toolchain/gvsoc/gapy/requirements.txt /app/gapy-requirements.txt && \
+    rm -rf toolchain/pulp-sdk toolchain/qemu toolchain/mempool toolchain/banshee toolchain/xtensor toolchain/xtl toolchain/xsimd toolchain/gvsoc && \
+    ccache -s
+
+# Install SoftHier emulator and toolchain
+RUN --mount=type=cache,target=/ccache \
+    ccache -z && \
     make SOFTHIER_INSTALL_DIR=/app/install/softhier softhier && \
     ccache -s
 
@@ -92,7 +94,8 @@ RUN mkdir -p /root/.cargo/bin/ && \
     libsdl2-dev \
     python-is-python3 \
     python3.10-venv \
-    python3.10-distutils && \
+    python3.10-distutils \
+    gcc && \
     curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && \
     python get-pip.py && \
     rm get-pip.py && \

Container/Dockerfile.toolchain

@@ -15,8 +15,8 @@ ENV PATH="/root/.cargo/bin:${PATH}"
 WORKDIR /app
 
 # Install dependencies
-RUN apt-get upgrade && \
-    apt-get update && \
+RUN apt-get update && \
+    apt-get upgrade -y && \
     apt-get install -y git-lfs \
     build-essential \
     ccache \

DeeployTest/testUtils/platformMapping.py

@@ -47,11 +47,9 @@
 from Deeploy.Targets.Snitch.Platform import SnitchOptimizer, SnitchPlatform
 from Deeploy.Targets.SoftHier.Deployer import SoftHierDeployer
 from Deeploy.Targets.SoftHier.Platform import SoftHierOptimizer, SoftHierPlatform
-from Deeploy.Targets.Chimera.Deployer import ChimeraDeployer
-from Deeploy.Targets.Chimera.Platform import ChimeraOptimizer, ChimeraPlatform
 
-_SIGNPROP_PLATFORMS = ["Apollo3", "Apollo4", "QEMU-ARM", "Generic", "MemPool"]
-_NONSIGNPROP_PLATFORMS = ["Siracusa", "Siracusa_w_neureka", "PULPOpen", "Snitch"]
+_SIGNPROP_PLATFORMS = ["Apollo3", "Apollo4", "QEMU-ARM", "Generic", "MemPool", "SoftHier"]
+_NONSIGNPROP_PLATFORMS = ["Siracusa", "Siracusa_w_neureka", "PULPOpen", "Snitch", "Chimera"]
 _PLATFORMS = _SIGNPROP_PLATFORMS + _NONSIGNPROP_PLATFORMS
 
 

README.md

@@ -26,8 +26,6 @@ You can find the documentation at the following links:
 
 A DeepWiki generated documentation is availabe [here](https://deepwiki.com/pulp-platform/Deeploy).
 
-A tutorial, originally made for the ETH SoCDAML course, is available in `Tutorials/SoCDAML.md`.
-
 ## Getting started
 
 Download the repository and its submodules: