Squashed commit of the following:

commit 5f52a39
Author: Juan Sapriza <[email protected]>
Date:   Thu Oct 5 10:47:23 2023 +0200

    Changed name

commit aeaa09a
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 18:03:15 2023 +0200

    Regrouped some docs

commit 32ff839
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 17:51:16 2023 +0200

    Separated headers in different files

commit 32a5c80
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 17:31:09 2023 +0200

    Added glob flag

commit 324fe7a
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 17:26:46 2023 +0200

    Modified the toctree to include sections

commit 80e63e6
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 14:47:12 2023 +0200

    Restructured a bit

commit 0117aa3
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 14:40:32 2023 +0200

    Added programflash

commit d140db1
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 14:40:18 2023 +0200

    Fixed some references

commit 1fcc7cb
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 14:29:38 2023 +0200

    Added main header to all files

commit df580c3
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 28 14:27:47 2023 +0200

    Moved documentatino files into the readthedocs directory

commit f9ce175
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 19:10:54 2023 +0200

    Removed useless comment

commit d7d3344
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 19:06:24 2023 +0200

    Updated toctree

commit ce5527a
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:58:39 2023 +0200

    Fixed name

commit 7cc0310
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:57:58 2023 +0200

    Moved the DMA docu

commit 285fb71
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:54:36 2023 +0200

    Updated the DMA doc

commit c5e7a4e
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:48:07 2023 +0200

    Modified title

commit c0bd1dc
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:47:19 2023 +0200

    Previous commit compiles. Added DMA to toctree

commit ac1382b
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:43:18 2023 +0200

    added requirements to config file

commit 9894723
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:41:01 2023 +0200

    Now added indeed the file

commit 00f2927
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:36:57 2023 +0200

    restored config.py

commit added00
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 18:35:46 2023 +0200

    Added config file

commit 918e5c8
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 17:59:54 2023 +0200

    removed the toctree

commit 5746a8a
Author: Juan Sapriza <[email protected]>
Date:   Wed Sep 27 17:47:30 2023 +0200

    Modified the toctree

commit 73877db
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:47:58 2023 +0200

    Added testing comment to see changes

commit b0f0710
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:46:49 2023 +0200

    Added a toctree at the end of the index

commit d6c83f1
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:43:46 2023 +0200

    Added testing comment to see changes

commit f759d4c
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:41:51 2023 +0200

    Added myst parser to the requirements and conf.py to support also markdown documentation

commit aeee424
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:33:56 2023 +0200

    Added DMA documentation in markdown

commit c540325
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:27:13 2023 +0200

    Revert "Readthedocs first integration"

    This reverts commit 46abbae.

commit f66fa6d
Author: Juan Sapriza <[email protected]>
Date:   Thu Sep 21 10:03:31 2023 +0200

    dummy change

commit 46abbae
Author: jose <[email protected]>
Date:   Tue Sep 12 16:53:05 2023 +0200

    Readthedocs first integration

commit 4e19e08
Author: jose <[email protected]>
Date:   Tue Sep 12 16:50:24 2023 +0200

    Readthedocs first integration

commit 162b16b
Merge: 27d4dda c1ebe34
Author: jmiranda <[email protected]>
Date:   Wed Sep 6 11:44:31 2023 +0200

    Merge branch 'esl-epfl:main' into main

commit 27d4dda
Merge: 868c4ec fe41598
Author: jmiranda <[email protected]>
Date:   Fri Jul 28 09:18:35 2023 +0200

    Merge branch 'esl-epfl:main' into main

commit 868c4ec
Author: jmiranda <[email protected]>
Date:   Wed May 31 17:21:34 2023 +0200

    Fill linker flash load up to __boot_address

commit 92784ce
Merge: bd5fab3 7dd2b02
Author: jmiranda <[email protected]>
Date:   Wed May 31 16:58:30 2023 +0200

    Merge branch 'esl-epfl:main' into main

commit bd5fab3
Merge: 8e3b578 ef90fb6
Author: jmiranda <[email protected]>
Date:   Wed May 24 12:37:18 2023 +0200

    Merge branch 'esl-epfl:main' into main

commit 8e3b578
Author: jmiranda <[email protected]>
Date:   Thu May 18 16:26:59 2023 +0200

    Added script file

commit 40af91f
Author: jmiranda <[email protected]>
Date:   Thu May 18 16:25:09 2023 +0200

    Added script to compile them all

commit 013bd49
Merge: 1ec980e 81b4459
Author: jmiranda <[email protected]>
Date:   Wed May 17 18:26:35 2023 +0200

    Merge branch 'esl-epfl:main' into app_fix

commit 1ec980e
Author: jmiranda <[email protected]>
Date:   Wed May 17 18:14:39 2023 +0200

    Fix compilation issues with some APPs

commit edff111
Merge: e332d09 02a1e8c
Author: jmiranda <[email protected]>
Date:   Wed May 17 17:59:12 2023 +0200

    Merge branch 'esl-epfl:main' into app_fix

commit e332d09
Author: jmiranda <[email protected]>
Date:   Mon May 15 14:17:43 2023 +0200

    Added vector file for freertos

commit 3ad1040
Merge: 6b33bbd 7170bf5
Author: jmiranda <[email protected]>
Date:   Mon May 15 12:27:26 2023 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit 6b33bbd
Author: jmiranda <[email protected]>
Date:   Mon May 15 12:19:15 2023 +0200

    Change crt logic based on supported preprocessor variables

commit 3de5278
Merge: 7635837 442a2b6
Author: jmiranda <[email protected]>
Date:   Tue May 9 14:57:11 2023 +0200

    Merge branch 'esl-epfl:main' into main

commit 7635837
Author: jmiranda <[email protected]>
Date:   Tue May 9 14:53:23 2023 +0200

    Updating CMake backend

commit 47dcad1
Merge: d177a8e c360be8
Author: jmiranda <[email protected]>
Date:   Wed Apr 5 05:03:01 2023 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit d177a8e
Merge: 1b6b468 9f9dd0f
Author: jmiranda <[email protected]>
Date:   Wed Apr 5 04:55:07 2023 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit 1b6b468
Author: jmiranda <[email protected]>
Date:   Wed Apr 5 04:52:00 2023 +0200

    Modify Readme

commit ad419db
Author: jmiranda <[email protected]>
Date:   Wed Apr 5 04:31:32 2023 +0200

    Add comment hjson

commit d8d6e2a
Author: jmiranda <[email protected]>
Date:   Wed Apr 5 04:25:33 2023 +0200

    Re-adjust ram. Re-size also stack and heap for on-chip linker

commit b32277a
Author: jmiranda <[email protected]>
Date:   Tue Apr 4 18:51:59 2023 +0200

    Fixing apps and CMakeLists

commit 7a5362b
Merge: a1d91d3 b3cd59f
Author: jmiranda <[email protected]>
Date:   Tue Apr 4 17:49:03 2023 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit a1d91d3
Author: jmiranda <[email protected]>
Date:   Fri Mar 31 07:52:12 2023 +0200

    Using the needed HEAP for the current freeRTOS example

commit 1eae6f8
Merge: 48065d9 ad7bbc2
Author: jmiranda <[email protected]>
Date:   Fri Mar 31 07:28:59 2023 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit 48065d9
Merge: 5d47c35 82f9fcb
Author: jmiranda <[email protected]>
Date:   Mon Feb 27 16:43:28 2023 +0100

    Merge remote-tracking branch 'upstream/main' into main

commit 5d47c35
Author: jmiranda <[email protected]>
Date:   Mon Feb 27 16:39:45 2023 +0100

    minor update

    remove some comments
    add additional command to directly run blinky freertos

commit 8cb859b
Author: jmiranda <[email protected]>
Date:   Mon Feb 27 16:35:21 2023 +0100

    fix CMake include list

commit db39d42
Author: jmiranda <[email protected]>
Date:   Mon Feb 27 16:00:45 2023 +0100

    CMake auto backend

    No need to deal with hard-coded paths, CMake searches for you! :)

commit 052007b
Author: jmiranda <[email protected]>
Date:   Tue Feb 14 13:21:33 2023 +0100

    Updating readme and app for freertos

commit e2a462a
Merge: 2845068 dcb85bb
Author: jmiranda <[email protected]>
Date:   Mon Feb 13 19:37:32 2023 +0100

    Merge remote-tracking branch 'upstream/main' into main

commit 2845068
Author: jmiranda <[email protected]>
Date:   Wed Jan 25 14:58:26 2023 +0100

    FPGA testing + commands automatizations

    - change pin assignment to get the tricolor led working for the freertos application
    - Modify readme files to update with all the different commands
    - created a gdbInit file

commit 1238aa4
Merge: 58e43e4 e83717e
Author: jmiranda <[email protected]>
Date:   Tue Jan 24 18:22:38 2023 +0100

    Merge remote-tracking branch 'upstream/main' into main

commit 58e43e4
Author: JoseCalero <[email protected]>
Date:   Tue Jan 24 15:50:52 2023 +0100

    Minor CMake, linker, freeRTOS, and Makefile modifications

    - Avoid creating an extra template for freertos linker.
    - Modifying CMakeLists to be compliant with all apps (baremetal and freertos based)
    - Readme and other minor modifications

commit f9a9629
Author: jmiranda <[email protected]>
Date:   Mon Jan 23 19:52:36 2023 +0100

    Update README.md

commit 9a25bf8
Author: jmiranda <[email protected]>
Date:   Thu Jan 5 15:55:56 2023 +0100

    Minor permission changes

commit e339eaa
Merge: b336f9d 6bb9751
Author: JoseCalero <[email protected]>
Date:   Thu Jan 5 15:20:58 2023 +0100

    Merge remote-tracking branch 'upstream/main'

commit b336f9d
Author: JoseCalero <[email protected]>
Date:   Thu Jan 5 15:17:49 2023 +0100

    Major commit includding Makefile doc automatisation, CMake, and FreeRTOS porting

    1. Makefile doc automatisation
    2. CMake
    3. FreeRTOS porting (new linker tpl, new vectors.S)

commit 2351ef9
Merge: 0947793 622ea5e
Author: jmiranda <[email protected]>
Date:   Fri Dec 16 17:00:59 2022 +0100

    Update + minor changes cmake

commit 0947793
Merge: 29dca2d f01ce35
Author: jmiranda <[email protected]>
Date:   Wed Nov 9 18:39:55 2022 +0100

    Merge remote-tracking branch 'upstream/main' into main

commit 29dca2d
Author: jmiranda <[email protected]>
Date:   Mon Oct 31 15:34:35 2022 +0100

    Added cmake + cpp with the same upstream folder structure

commit e504411
Merge: bd75bfa c81da6a
Author: jmiranda <[email protected]>
Date:   Mon Oct 31 14:32:49 2022 +0100

    Merge remote-tracking branch 'upstream/main' into main

commit bd75bfa
Merge: aa1e5a4 d04c311
Author: jmiranda <[email protected]>
Date:   Fri Oct 28 11:56:46 2022 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit aa1e5a4
Merge: c5599f3 d8a080d
Author: jmiranda <[email protected]>
Date:   Tue Oct 25 14:16:26 2022 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit c5599f3
Merge: e7446ba cb66c87
Author: jmiranda <[email protected]>
Date:   Tue Oct 18 16:41:47 2022 +0200

    Merge branch 'esl-epfl:main' into main

commit e7446ba
Merge: d1cc7d2 374e2fc
Author: jmiranda <[email protected]>
Date:   Tue Sep 13 10:14:25 2022 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit d1cc7d2
Author: jmiranda <[email protected]>
Date:   Mon Aug 29 16:09:54 2022 +0200

    linker modification for the flash (.data section being in wrong place)

commit 57e2303
Merge: 2551109 9b95764
Author: jmiranda <[email protected]>
Date:   Mon Aug 29 08:06:40 2022 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit 2551109
Author: jmiranda <[email protected]>
Date:   Fri Aug 26 09:51:29 2022 +0200

    Added macro for uart baudrate by default based on the target

commit 058a58b
Merge: 059e67c ea2ff5e
Author: jmiranda <[email protected]>
Date:   Fri Aug 26 09:46:59 2022 +0200

    Merge remote-tracking branch 'upstream/main' into main

commit 059e67c
Author: jmiranda <[email protected]>
Date:   Thu Aug 25 19:23:15 2022 +0200

    fix uart pins and spi flash memory size

commit 4945c02
Merge: 135c9d3 5d3c22d
Author: jmiranda <[email protected]>
Date:   Wed Aug 17 18:58:47 2022 +0200

    updating with upstream main

commit 135c9d3
Merge: fd12f2d f1a8637
Author: jmiranda <[email protected]>
Date:   Fri Aug 12 17:50:26 2022 +0200

    Merge branch 'main' into main

commit fd12f2d
Author: jmiranda <[email protected]>
Date:   Thu Aug 11 16:56:23 2022 +0200

    sw Makefile and general readme minor modifications

    - For the Makefile within the SW folder, the wildcard was not behaving as expected for GNU make 4.3.
    - For the general Readme, added the verible stuff before any make, and adding an initial folder structure. This structure can be helpful for someone new to get a initial organizational sense of the project.

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,18 @@
+# Copyright 2023 EPFL
+# Solderpad Hardware License, Version 2.1, see LICENSE.md for details.
+# SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+#
+# Author: ESL
+
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx-rtd-theme
+myst-parser

AnalogMixedSignal.md → docs/source/How_to/AnalogMixedSignal.md

@@ -1,4 +1,4 @@
-# Analog / Mixed-Signal Simulation of X-HEEP
+#  integrate Analog / Mixed-Signal simulations
 
 ## About