DOC: Generate the charset tables dynamically from codes #3409
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,35 @@ | ||
| --- | ||
| file_format: mystnb | ||
| --- | ||
|
|
||
| ```{code-cell} | ||
| --- | ||
| tags: [remove-input] | ||
| --- | ||
| from IPython.display import display, Markdown | ||
| from pygmt.encodings import charset | ||
|
|
||
|
|
||
| def get_charset_mdtable(name): | ||
|
There was a problem hiding this comment. This function is modified from the original script at #3206 (comment) |
||
| """ | ||
| Create a markdown table for a charset. | ||
| """ | ||
| mappings = charset[name] | ||
|
|
||
| undefined = "\ufffd" | ||
| text = "| Octal | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 |\n" | ||
| text += "|:---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|\n" | ||
| for i in range(0o00, 0o400, 8): | ||
| chars = [mappings.get(j, undefined) for j in range(i, i + 8)] | ||
| if chars == [undefined] * 8: | ||
| continue | ||
| chars = [f"&#x{ord(char):04x};" for char in chars] | ||
| row = f"\\{i:03o}"[:-1] + "x" | ||
| text += f"| **{row}** | {' | '.join(chars)} |\n" | ||
| text += "\n" | ||
| return Markdown(text) | ||
| ``` | ||
|
|
||
| # Supported Encodings and Non-ASCII Characters | ||
|
|
||
| GMT supports a number of encodings and each encoding contains a set of ASCII and | ||
|
|
@@ -10,100 +42,33 @@ that the character is not defined in the encoding. | |
|
|
||
| ## Adobe ISOLatin1+ Encoding | ||
|
|
||
| ```{code-cell} | ||
| --- | ||
| tags: [remove-input] | ||
| --- | ||
| display(get_charset_mdtable("ISOLatin1+")) | ||
| ``` | ||
|
|
||
| ## Adobe Symbol Encoding | ||
|
|
||
| ```{code-cell} | ||
| --- | ||
| tags: [remove-input] | ||
| --- | ||
| display(get_charset_mdtable("Symbol")) | ||
| ``` | ||
|
|
||
| **Note**: The octal code `\140` represents the RADICAL EXTENDER character, which is not | ||
| available in the Unicode character set. | ||
|
|
||
| ## Adobe ZapfDingbats Encoding | ||
|
|
||
| ```{code-cell} | ||
| --- | ||
| tags: [remove-input] | ||
| --- | ||
| display(get_charset_mdtable("ZapfDingbats")) | ||
| ``` | ||
|
|
||
| ## ISO/IEC 8859 | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is the CSS styles from myst-nb.
The
text-alignis set toright, which makes sense for displaying objects likepandas.DataFrame(an example at https://myst-nb.readthedocs.io/en/latest/render/format_code_cells.html#remove-stdout-or-stderr).In MyST, the table cell alignment can be controlled using
:characters (https://myst-parser.readthedocs.io/en/latest/syntax/tables.html), which is done by assigningtext-left/text-center/text-rightto cells. These CSS classes are not defined in Sphinx_rtd_theme, so we have to define them here.