Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/prepare documentation #138

Merged
merged 13 commits into from
Aug 25, 2023

Conversation

christian-herber-nxp
Copy link

This PR adds the technical specification of CV32E20 to the documentation. The original documentation of Ibex is kept and subject to future work.
Also, a readme.md was added in the doc directory, which has the instructions for building the documentation.

@christian-herber-nxp
Copy link
Author

Please see if you are able to build the documentation using the instructions in the Readme.

@DBees
Copy link

DBees commented Aug 22, 2023

@christian-herber-nxp could not build on windows. Will try on linux

@DBees
Copy link

DBees commented Aug 23, 2023

@christian-herber-nxp due to a problem on my computer I was not able to test the linux build, will be able to do that tomorrow. However I noticed you are missing the .readthedocs.yaml configuration file in the top level of the repo. You can copy this one https://github.com/openhwgroup/core-v-mcu-devkit/blob/main/.readthedocs.yaml. Can you please push that in, then we will merge this PR and see if it builds on the read the docs site.

@christian-herber-nxp
Copy link
Author

@christian-herber-nxp due to a problem on my computer I was not able to test the linux build, will be able to do that tomorrow. However I noticed you are missing the .readthedocs.yaml configuration file in the top level of the repo. You can copy this one https://github.com/openhwgroup/core-v-mcu-devkit/blob/main/.readthedocs.yaml. Can you please push that in, then we will merge this PR and see if it builds on the read the docs site.

Thanks, updated the PR

@MikeOpenHWGroup
Copy link
Member

LGTM @christian-herber-nxp. I will defer to @DBees for the final merge.

@DBees DBees merged commit b3bf9c6 into openhwgroup:main Aug 25, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants