-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC shapes and collections is fully SG compatible #8310
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
DOC shapes and collections is fully SG compatible #8310
Conversation
@@ -2,6 +2,9 @@ | |||
================ | |||
PathPatch object | |||
================ | |||
|
|||
This example shows how to create Paths and PathPatch objects through |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Backticks for cross-references? (Does that work here?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`Path`\s
(see e.g. https://github.com/anntzer/mplcursors/blame/master/doc/index.rst#L126, rendered at https://mplcursors.readthedocs.io/en/stable/#customization ("Line2Ds"))
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
backticks might work automatically for cross references. There's unfortunately no easy way to check this just yet, but we'll see once I merge this branch into the sphinx-gallery branch.
@@ -2,6 +2,9 @@ | |||
================ | |||
PathPatch object | |||
================ | |||
|
|||
This example shows how to create `Path`\s and `PathPatch` objects through | |||
Matplotlib's API. | |||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need blank lines around this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure I understand the question. If you are asking about the need for blanklines around """
, then the answer is no.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK sweet 👍
Thanks! |
This is the last part to make the folder shapes and collection fully sphinx-gallery compatible.