A few changes #44
Merged
A few changes #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Added the Python package to lint the generated files. * Add the 'test_rst' target in the Makefile (as the test_c) * Added to the ci pipeline Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
… code. RstCloth: A simple Python API for generating RestructuredText. https://pypi.org/project/rstcloth/ It reduced a bit the own Python code. The output stays the same. * Except some white spacing alignent. What's nice to have, but not needed because the generated RST files are just an input to generated the real document. * underline symbols of the sections is now more in line with the kind-of-standard https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections Linting at RST is done and ok. Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
A design can have multiple IP's with registers. And although IP-XACT can handle this, the tool right now only starts at the addressBlock level. But when collecting the generated documentation (restucturedText or MarkDown) into one document is useful to have the name of the IP as the title of the generated file. This fixes issue oddball#43: ipxact2hdlCommon.py returnRstTitle returns hardcoded string iso addressBlock.name Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Added the description into the test xml file. Added it to the generated MarkDown and restructuredText files. Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Python was trowing an error if a entry was not in the ini file and the ini file was used. Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
check first whether there is a description for the addressBlock
Update ipxact2hdlCommon.py
|
@oddball Thanks for the release! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@oddball
A few changes.
CircleCI and local test where fine.
Could you merge them if you want and create a new release
Thanks for the tool!
PS: what is still open on the long run