GenomicMedLab / cool-seq-tool

https://coolseqtool.readthedocs.io
MIT License
4 stars 0 forks source link

docs: fix residue mode illustration rendering #281

Closed jsstevenson closed 8 months ago

jsstevenson commented 8 months ago

The existing lil ASCII table in the ResidueMode docstring wouldn't render properly in Sphinx nor in markdown-style blocks (eg in VSCode popups). This adds an RST table and retains the ASCII table but puts it in a code block, and then strips the ASCII table out when constructing the Sphinx autodoc page.

Broken:

Screenshot 2024-03-21 at 10 11 14 AM

Fixed in VSCode (it auto ignores all of the RST stuff):

Screenshot 2024-03-21 at 10 12 32 AM

Fixed in Sphinx docs:

Screenshot 2024-03-21 at 10 11 33 AM