Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[markov_chain_I] Move example subsections to sphinx-proof examples #502

Open
Jiarui-ZH opened this issue Jul 4, 2024 · 3 comments
Open
Assignees

Comments

@Jiarui-ZH
Copy link
Contributor

@jstac, currently the markov_chain_I lecture has a lot of examples subheadings and can be a bit confusing to read. It was suggested by @mmcky that we could try use the proof domain and utilise {prf:ref} (https://sphinx-proof.readthedocs.io/en/latest/syntax.html) to make them look neater.

@Jiarui-ZH Jiarui-ZH changed the title [markov_chain_I] [markov_chain_I] Editorial suggestion 2 Jul 4, 2024
@jstac
Copy link
Contributor

jstac commented Jul 4, 2024

Good idea!

@mmcky
Copy link
Contributor

mmcky commented Jul 5, 2024

@Jiarui-ZH - the one limitation sphinx-proof has at the moment is that they cannot contain executable code cells (you can show code but not execute it as jupyter restricts executable code to be at the root level of a document).

On a first pass you will want to migrate to https://sphinx-proof.readthedocs.io/en/latest/syntax.html#examples that don't have executable code.

I have been doing some work on sphinx-proof this week to update styles, and I will try to add support for gated directives next week -- which is required for supporting executable code blocks.

@mmcky
Copy link
Contributor

mmcky commented Jul 5, 2024

@mmcky mmcky changed the title [markov_chain_I] Editorial suggestion 2 [markov_chain_I] Move example subsections to sphinx-proof examples Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants