[Doc] link style sheets reference to customization tutorial #26195
Conversation
|
As for the linting error with flake8, I don't know how to cut a long line which contains a reference: See more details in :ref:`Customizing Matplotlib using style sheets<customizing-with-style-sheets>`. |
| in the list `matplotlib.style.available` | ||
| (they are also printed in the corner of each plot below). | ||
|
|
||
| See more details in :ref:`Customizing Matplotlib using style sheets<customizing-with-style-sheets>`. |
There was a problem hiding this comment.
| See more details in :ref:`Customizing Matplotlib using style sheets<customizing-with-style-sheets>`. | |
| See more details in | |
| :ref:`Customizing Matplotlib using style sheets<customizing-with-style-sheets>`. |
should work (in the sense that there will not be a line break there in the rendered page).
There was a problem hiding this comment.
You can break anywhere in the backticks, so just break normally on spaces.
|
Thanks for the feedback. I've cut in the backticks. Let's see what flake8 think of it... |
|
The doc seems to render nicely (although the job "View the built doc" reports an error): https://output.circle-artifacts.com/output/job/79f5301c-9e02-43be-abc2-48313435779f/artifacts/0/doc/build/html/gallery/style_sheets/style_sheets_reference.html#sphx-glr-gallery-style-sheets-style-sheets-reference-py |
+ fix typo "RcParams"
|
The built doc looks correct: https://output.circle-artifacts.com/output/job/93ee1604-39b1-4990-b7d7-1c41df1111f5/artifacts/0/doc/build/html/gallery/style_sheets/style_sheets_reference.html#sphx-glr-gallery-style-sheets-style-sheets-reference-py and the link to |
|
Are there some remaining changes (like rebasing?) that I need to do for having this PR ready to merge? |
…stomization tutorial
…stomization tutorial
…195-on-v3.7.2-doc Backport PR #26195 on branch v3.7.2-doc ([Doc] link style sheets reference to customization tutorial)
…195-on-v3.7.x Backport PR #26195 on branch v3.7.x ([Doc] link style sheets reference to customization tutorial)
|
Thanks for the merge @ksunden! |
PR summary
While sharing the Style sheets reference gallery page to a colleague, I realized it's not self-contained in the sense that it doesn't explain how to use style sheets nor does it link to the corresponding Customizing Matplotlib with style sheets tutorial.
In this small expansion of the top docstring of
style_sheets_reference.py, I added:plt.style.useand a mention tomatplotlib.style.available(which is used in the script, but it's quite buried)PR checklist
However, since I don't have a proper devel setup, I unfortunately didn't check that the Sphinx compilation runs fine. Hopefully my change is small enough that I didn't introduce a syntax error, but it's far from sure...