Skip to content

Match Markdown to LaTeX documentation#66

Merged
tgingold-cern merged 2 commits intotgingold-cern:masterfrom
lorenzschmid:md
Aug 25, 2025
Merged

Match Markdown to LaTeX documentation#66
tgingold-cern merged 2 commits intotgingold-cern:masterfrom
lorenzschmid:md

Conversation

@lorenzschmid
Copy link
Contributor

The overall goal of this PR is to improve the Markdown documentation generation such that it can easily be displayed in GitLab and GitHub. Since some of the tables in the Markdown documentation are generated based on AsciiDoc, GitLab and GitHub failed to display them properly. Overall, the following points have been addressed:

  • Match Markdown output to LaTeX documentation
  • Generate HTML tables instead of AsciiDoc tables for register drawings (showing which bit field is placed where in the register)

@lorenzschmid
Copy link
Contributor Author

This might actually fix #47 as it removes the AsciiDoc style the OP mentions.

@tgingold-cern tgingold-cern merged commit cdc74b9 into tgingold-cern:master Aug 25, 2025
2 checks passed
@tgingold-cern
Copy link
Owner

Thanks!

@lorenzschmid lorenzschmid deleted the md branch August 25, 2025 08:58
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.

2 participants