Fix tables markdown for classes in gendoc #137
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
In current markdown template, in the "Instances of" section, the current
implementation is rendered as "code block" by github and by pandoc.
I think this is because of the indentation of the html bits. html tags
and special characters are escaped by pandoc, i.e. the html source reads
```
table border="1" cellspacing="3" cellpadding="5" class="classproperties table-hover ">
<pre><code><tr>
<th height="40">Property</th><th>Description</th><th>Expected Type</th>
</tr>
[etc...]
```
I have reindented the template file so that the table is correctly included as
html, this seems to fix the issue.
Another way forward would be not to include html tables here, but use
the generally accepted markdown syntax for tables. An issue is to render
the 3-column span. Maybe split tables...
An attempt to move away from html tags, to let mardown-to-html renderers use their own style. Note the dash in the jinja markup to avoid harmful newlines.
Since Python 3.2, configparser.SafeConfigParser is deprecated It has been removed in Python 3.11 Simply calling configparser.ConfigParser works in python 3.12
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.
Hello,
Thanks for this useful tool. This pull request proposes an update of the markdown template for classes in gendoc, with which I had some issues.
The first commit is simply removing some leading spaces that caused pandoc (as well as the github markdown renderer) to consider the subsequent HTML-formatted table as a code block, hence escaping the html tags and special characters, and causing the actual html code to be displayed instead of a table when rendered as html.
Then I tried to switch to the usual way to encode tables in markdown, thus avoiding the HTML tags. I had to tweak the jinja tags to avoid newlines that broke the markdown table format.
Last I noticed missing parenthesis after the "description" item, causing the reference to the function appear instead of the returned value.
I hope you will find these suggestions useful.