Readthedocs first integration #374
Conversation
- 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.
…TOS porting 1. Makefile doc automatisation 2. CMake 3. FreeRTOS porting (new linker tpl, new vectors.S)
- 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
- 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
No need to deal with hard-coded paths, CMake searches for you! :)
remove some comments add additional command to directly run blinky freertos
🥳 Good news!
As an example I added the Requirements to add new documents
Additional changesTo accommodate all these changes I had to
|
|
@JoseCalero One thing I noticed is that the docu is always seen until half the screen
Do you know if this is a configuration? |
|
I added all the documentation that was floating around in the base directory into a @JoseCalero @davideschiavone @simone-machetti you guys might want to take a look at how its looking, because some documentation might need some update or reorganizing/relabelling In particular, the last section of External Devices is referring to the memcopy peripheral which i dont quite remember what was of it |
| @@ -92,8 +92,8 @@ To create and maintain a peripheral unit efficiently, use the `reggen` tool: | |||
|
|
|||
| 2. Launch the `regtool.py` script to generate SystemVerilog RTL code and a C header file. | |||
|
|
|||
| For example, launching the script [`memcopy_periph_gen.sh`](./hw/ip_examples/memcopy_periph/memcopy_periph_gen.sh) generates 2 SystemVerilog files and one C header file: | |||
There was a problem hiding this comment.
All the references to the mempy peripheral should be removed
docs/source/How_to/GettingStarted.md
Outdated
| @@ -0,0 +1,123 @@ | |||
| # get started | |||
There was a problem hiding this comment.
The documentation inside the How to folder should be harmonized
There was a problem hiding this comment.
We should also add a document on how to document.
JoseCalero
removed request for
davideschiavone,
ruben-roalvarez and
StefanoAlbini96
First integration of the documentation engine. Both for local building and for online readthedocs building management (you can already see the output in here).
From this point we can already discuss how we want the documentation to be organized, displayed, etc.