Posts tagged sphinx

MySt and Markdown for Sphinx Cheatsheet

Iโ€™ve never been a fan of Re-StructuredText, but most importantly Iโ€™m new to MySt, which leads to a lot of googling and painstaking trial-and-error while writing. Although my preferred references are the Jupyter Book MyST Cheatsheet, the Sphinx Book Theme Documentation, and the MyST Parser Reference, they are way too extensive, sometimes incorrect, and I donโ€™t really use every directive or variant thereof. Therefore, Iโ€™ll use this post to gather the bits of the syntax and snippets I use the most.

Read more ...

Load Sphinx environment.pickle and List all Labels

In order to come up with a reliable and standardized way of referring to document sections and document it in MySt and Markdown for Sphinx Cheatsheet, I went down a pretty deep rabbit hole of Sphinx label manipulations.

Read more ...