github-mirrors/cva6
1
0
Fork 0
mirror of https://github.com/openhwgroup/cva6.git synced 2025-04-25 14:47:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

doc: keep documentation in sync with the code (#2558)
Some checks failed
bender-up-to-date / bender-up-to-date (push) Has been cancelled
Details
ci / build-riscv-tests (push) Has been cancelled
Details
ci / execute-riscv64-tests (push) Has been cancelled
Details
ci / execute-riscv32-tests (push) Has been cancelled
Details

Browse source 
Both the ISA and design documentations use some parameters generated from the RTL (ports, parameters).
As of now, they are committed to the repository and can be out of sync with the code.

This PR removes them from the repository and freshly generates them from the code when building HTML files.

This PR also removes prebuilt HTML files (design & ISA docs) and generates them when building the top-level Read the Docs documentation (make -C docs).
This commit is contained in:
slgth 2024-10-25 12:27:09 +02:00 • committed by GitHub
parent 01c636dd55
commit ab2283c075
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
53 changed files with 204 additions and 79451 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/scripts/parameters_extractor.py
View file

@ -19,7 +19,7 @@ from classes import Parameter
sys.path.append(os.getcwd() + "/../util")
from user_config import get_config
def parameters_extractor(spec_number, target):
def parameters_extractor(target):
parameters = {}
file_in = "../core/include/config_pkg.sv"