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

Fixes RST link formatting. #1621

Merged
merged 3 commits into from
Jan 19, 2022
Merged

Fixes RST link formatting. #1621

merged 3 commits into from
Jan 19, 2022

Conversation

andsteing
Copy link
Collaborator

Unfortunately, "source formatted" links like

see optax

are not supported in RST:

So removing the "source formatting" so these links render as normal text (but
with correct link formatting) in both Colab and RTD.

This will close overdue #659

Unfortunately, "source formatted" links like

see [`optax`](https://optax.readthedocs.io/)

are not supported in RST:

- spatialaudio/nbsphinx#301
- https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible

So removing the "source formatting" so these links render as normal text (but
with correct link formatting) in both Colab and RTD.
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Collaborator

@8bitmp3 8bitmp3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm @andsteing

Lines 298-299 - maybe also remove the backticks in Module.apply?

    "Create a function that evaluates your model on the test set with\n",
-     "[`Module.apply`](https://flax.readthedocs.io/en/latest/flax.linen.html#flax.linen.Module.apply)"
+     "[Module.apply](https://flax.readthedocs.io/en/latest/flax.linen.html#flax.linen.Module.apply)"

@andsteing
Copy link
Collaborator Author

@8bitmp3 good catch, removed those as well...

@jheek jheek added the Priority: P2 - no schedule Best effort response and resolution. We have no plan to work on this at the moment. label Oct 21, 2021
docs/notebooks/annotated_mnist.ipynb Outdated Show resolved Hide resolved
@andsteing andsteing merged commit 7c98266 into google:main Jan 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Priority: P2 - no schedule Best effort response and resolution. We have no plan to work on this at the moment. pull ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants