https://jdsalaro.comJayson Salazar Rodriguez | @jdsalaro | Blog - Posts tagged sphinx2025-12-26T16:36:53.745568+00:00ABlog@jdsalarohttps://jdsalaro.com/cheatsheet/sphinx-myst-markdown/MySt and Markdown for Sphinx Cheatsheet2023-07-12T00:00:00+00:00Jayson Salazar Rodriguez<p class="ablog-post-excerpt"><p>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 <a class="reference external" href="https://jupyterbook.org/en/stable/reference/cheatsheet.html">Jupyter Book MyST Cheatsheet</a>, the <a class="reference external" href="https://sphinx-book-theme.readthedocs.io/en/stable">Sphinx Book Theme Documentation</a>, and the <a class="reference external" href="https://myst-parser.readthedocs.io/en/latest/syntax">MyST Parser Reference</a>, 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.</p>
</p>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
name: "python3",
path: "./blog/tag"
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>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.2023-07-12T00:00:00+00:00https://jdsalaro.com/howto/sphinx-load-environment-pickle/Load Sphinx environment.pickle and List all Labels2023-07-10T00:00:00+00:00Jayson Salazar Rodriguez<p class="ablog-post-excerpt"><p>In order to come up with a reliable and standardized way of referring to document sections and document it in <a class="reference internal" href="../../../cheatsheet/sphinx-myst-markdown/"><span class="doc">MySt and Markdown for Sphinx Cheatsheet</span></a>, I went down a pretty deep rabbit hole of Sphinx label manipulations.</p>
</p>
<script type="text/x-thebe-config">
{
requestKernel: true,
binderOptions: {
repo: "binder-examples/jupyter-stacks-datascience",
ref: "master",
},
codeMirrorConfig: {
theme: "abcdef",
mode: "python"
},
kernelOptions: {
name: "python3",
path: "./blog/tag"
},
predefinedOutput: true
}
</script>
<script>kernelName = 'python3'</script>In order to come up with a reliable and standardized way of referring to document sections and document it in /cheatsheet/sphinx-myst-markdown, I went down a pretty deep rabbit hole of Sphinx label manipulations.2023-07-10T00:00:00+00:00