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

Convert rST links to Markdown in autogenerated Notebooks #2653

Closed
nicolossus opened this issue Mar 28, 2023 · 3 comments
Closed

Convert rST links to Markdown in autogenerated Notebooks #2653

nicolossus opened this issue Mar 28, 2023 · 3 comments
Assignees
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Bug Wrong statements in the code or documentation

Comments

@nicolossus
Copy link
Member

Describe the flaw
Links are not rendered properly in the Notebooks autogenerated from the example scripts. For example, the link to the One neuron example in the Two neuron example Notebook is displayed as the raw rST :doc:`one_neuron`.

Suggest an improvement
Based on the sphinx-gallery documentation (https://sphinx-gallery.github.io/stable/configuration.html#using-pypandoc-to-convert-rst-to-markdown), it seems like pypandoc can be used to automatically convert rST to Markdown:

sphinx_gallery_conf = {
    ...
    'pypandoc': True,
}
@nicolossus nicolossus added T: Bug Wrong statements in the code or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels May 4, 2023
@jessica-mitchell
Copy link
Contributor

@nicolossus I have experimented with this option and a couple of other things, but I have yet to actually manage to get the conversion to work properly. Up to now, I only get markup that looks like {.interpreted-text role="doc"} in the final notebook.

@github-actions
Copy link

Issue automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Aug 27, 2023
@jessica-mitchell
Copy link
Contributor

Closing issue; no adequate solution was found

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Bug Wrong statements in the code or documentation
Projects
Status: Done
Development

No branches or pull requests

2 participants