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

Vermaete/sphinx #53

Merged
merged 2 commits into from
Nov 26, 2023
Merged

Vermaete/sphinx #53

merged 2 commits into from
Nov 26, 2023

Conversation

vermaete
Copy link
Collaborator

@vermaete vermaete commented Nov 25, 2023

@oddball

Hi Andreas,

This PR will create the possibility to generated a RestructuredText file with Wavedrom Bitfield diagrams in the by Sphinx generated PDF.

The example of the PDF is added to the output examples.

Enabling this feature is done in the configuration file.

[rst]
wavedrom = yes

The Spinx configuration file is also part of the new example/output_sphinx/ directory.
Important here is the Sphinx plugingto convert the wavedrom code into an diagram in the ouput of Sphinx.
https://github.com/bavovanachte/sphinx-wavedrom

Could you review and create a release if if fits you.
You may delete this (and the previous) feature branch.

Br,

Enabling 'wavedrom' under 'rst' in the config init files will generate
a RestructuredText file with an image of the register generated with Wavedrom.

@see: https://github.com/wavedrom/bitfield

Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Copy link
Owner

@oddball oddball left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@oddball oddball merged commit ad5259f into master Nov 26, 2023
2 checks passed
@oddball oddball deleted the vermaete/sphinx branch November 26, 2023 10:11
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.

None yet

2 participants