changed to RST #25594

Higgs32584 · 2023-03-31T18:44:25Z

created draft pull request for issue#25582, documentation

.gitignore

tacaswell · 2023-03-31T19:14:16Z

galleries/users_explain/toolkits/axes_grid.rst

@@ -0,0 +1,332 @@
+.. redirect-from:: /tutorials/toolkits/axes_grid


Should this also be a move?

tacaswell · 2023-03-31T19:15:00Z

Even though this is documentation, it can not be backported because it relies on the re-organization.

Higgs32584 · 2023-03-31T19:25:32Z

Apologies! This was more so a draft for the moment. I was not planning on committing a .git ignore

Higgs32584 · 2023-03-31T19:28:51Z

What I am trying to resolve is the fact that the three changed files download as full commented blocks. I initially was planning on just reformatting the file, but it was suggested that I change the files to .rst.

If I was going to do that where would I move it to?

tacaswell · 2023-03-31T19:35:49Z

github is detecting 2 renames of .py -> .rst and reporting one wholly new .rst. I suspect that means you missing a git rm <file name> command.

Higgs32584 · 2023-03-31T19:55:49Z

I do not know what that is the case. I did not modify the location.
https://github.com/matplotlib/matplotlib/blob/main/galleries/users_explain/toolkits/axes_grid.py

jklymak · 2023-03-31T20:05:04Z

When you rename a file, you should use "git mv" so git knows that is what you did versus delete a file and add a new one. https://git-scm.com/docs/git-mv

Higgs32584 · 2023-03-31T20:08:17Z

@jklymak Ok will do, thank you!

Higgs32584 · 2023-03-31T21:05:32Z

would this make a solid index.rst for

C:/Users/mjhig/.vscode/bob/matplotlib/galleries/users_explain/toolkits



.. _tutorials-toolkits:

.. redirect-from:: /tutorials/toolkits

Toolkits
--------

These tutorials cover toolkits designed to extend the functionality
of Matplotlib in order to accomplish specific goals.
.
.. toctree::
    :maxdepth: 2

    axes_grid.rst
    axisartist.rst
    mplot3d.rst

tacaswell · 2023-03-31T22:01:04Z

.gitignore

@@ -1,112 +0,0 @@
-#########################################


Deleting our .gitignore is also not something we can merge!

Higgs32584 · 2023-03-31T23:13:16Z

I am very sorry I can redo the pull request if necessary, I am sorry about the .gitignore it was not meant to be committed, but now that the changes are staged it got really messy, I can close this pull request if you want. It was getting annoying trying to explain the code, so I made a pull request to get feedback.

ksunden · 2023-04-01T00:35:26Z

FYI, you can tweak your description a bit to automatically link the issue by using special codewords like "Closes #XXXXX". I have added it to this PR manually, but for future reference.

https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue

As for the gitignore stuff, consider rebasing, no need to start a new PR if the overall change is still wanted (I honestly haven't taken a close look), it can be done here:

https://matplotlib.org/stable/devel/development_workflow.html#rewriting-commit-history

Higgs32584 · 2023-04-01T02:00:42Z

Can someone tell me if I put the .rst files in the right place? Also I'm wondering if the index.rst works to

jklymak · 2023-04-01T15:31:39Z

No we can't tell you if you have put it in the right place because you haven't committed it. You may want to carefully go through our guide to git and Github, it is actually relatively decent: https://matplotlib.org/stable/devel/development_workflow.html. Let us know if parts of it are not clear.

Higgs32584 · 2023-04-01T15:35:13Z

@jklymak ok I will!! I apologize, I haven’t used GitHub with this much version control before! I have only done small projects before! I really look forward to completing my contribution. Thank you!

Higgs32584 · 2023-04-07T16:05:47Z

accident

jklymak · 2023-04-09T15:30:43Z

@Higgs32584 This is unlikely to be building properly though for some reason CI is not running for the job. But the rst files must be formatted like rst files. You probably also have to git remove the README.txt from the source directory.

You should be able to build and check this locally using make html-skip-subdirs

melissawm · 2023-04-13T18:34:41Z

Hello @Higgs32584 - let me know if you'd like to connect and come up with a plan for this ☺️ We can chat over at gitter or set up a meeting over zoom. Cheers!

Higgs32584 · 2023-04-13T18:44:17Z

Ok, I will! I just did not know how to set up a circle CI pipeline

melissawm · 2023-04-13T19:11:50Z

I think this is on us @Higgs32584 - see #25672 (takeaway is don't worry about it 😄 )

Higgs32584 · 2023-04-13T19:31:00Z

Hi, is there anything else that needs to be done? melissawm

jklymak · 2023-04-13T19:36:22Z

galleries/users_explain/toolkits/axes_grid.rst

I think these still need to strip the """ at the beginning and end, or it won't build.

my bad! removed quotations! Anything else I can do? Thank you for being so patient!
@tacaswell
@jklymak
@melissawm

jklymak · 2023-04-13T20:46:44Z

galleries/users_explain/toolkits/index.rst

+
+Here you can find examples and explanations of how to use various toolkits available in Matplotlib.
+
+Axes Artist


Is there a good reason to not just have these in one TOC?

Otherwise this looks good!

I guess that is how I got it to look the way it did before

Before it was a bunch of broken sphinx gallery thumbnails. https://matplotlib.org/devdocs/users/explain/toolkits/index.html I don't think anything is gained by having a title with almost the same thing written beneath it as a one-entry table of contents.

https://output.circle-artifacts.com/output/job/53486b53-726d-4792-9885-525ff863a886/artifacts/0/doc/build/html/users/explain/toolkits/index.html

I see, but how do you get it to generate the same way as before?

"The same ways as before" was just three broken thumbnails (https://matplotlib.org/devdocs/users/explain/toolkits/index.html). Why do you want that?

If you want something graphical, you could create an rst page with select images that are inside the tutorials. If you want the cards that are used for sphinx gallery, you could copy their style and use them on this rst page. You could also perhaps do something with sphinx-design.

If you decide to do this (which I'm not asking for, I'm just asking for you not to include three subheadings that each contain a table of contents) look at examples in the source code of where images have been included.

Higgs32584 · 2023-04-17T21:33:22Z

They need a computer science on git conflict theory

jklymak · 2023-04-17T22:12:55Z

/home/circleci/project/doc/users/explain/toolkits/axisartist.rst:563: WARNING: Bullet list ends without a blank line; unexpected unindent.

jklymak

Thanks for working through this!

rcomer · 2023-04-18T07:11:21Z

Congratulations on your first PR merged into Matplotlib @Higgs32584!

Higgs32584 · 2023-04-18T11:55:08Z

Thank you! @rcomer

Made user_explain/toolkits an rst-only gallery entry. Co-authored-by: Higgs32584 <[email protected]>

tacaswell reviewed Mar 31, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

tacaswell reviewed Mar 31, 2023

View reviewed changes

tacaswell added this to the v3.8.0 milestone Mar 31, 2023

tacaswell reviewed Mar 31, 2023

View reviewed changes

ksunden linked an issue Apr 1, 2023 that may be closed by this pull request

[Doc]: Commented Out Code in Downloadable Examples for Toolkits Tutorials #25582

Closed

Higgs32584 force-pushed the documentation_1 branch from d366cbb to b7ee03d Compare April 7, 2023 15:56

Higgs32584 closed this Apr 7, 2023

Higgs32584 force-pushed the documentation_1 branch from b7ee03d to a844eca Compare April 7, 2023 15:57

Higgs32584 reopened this Apr 7, 2023

Higgs32584 marked this pull request as ready for review April 8, 2023 16:29

jklymak reviewed Apr 13, 2023

View reviewed changes

Higgs32584 requested review from tacaswell and jklymak April 13, 2023 19:48

jklymak reviewed Apr 13, 2023

View reviewed changes

Higgs32584 closed this Apr 17, 2023

Higgs32584 force-pushed the documentation_1 branch from fbb44c9 to 2c4f552 Compare April 17, 2023 21:18

Higgs32584 and others added 3 commits April 17, 2023 17:27

made my previous changes

4e69b16

merged

2edb12e

Merge branch 'matplotlib:main' into documentation_1

dee8460

Higgs32584 reopened this Apr 17, 2023

Higgs32584 requested a review from jklymak April 17, 2023 21:33

Higgs32584 and others added 2 commits April 17, 2023 18:54

Merge branch 'matplotlib:main' into documentation_1

4edc574

merged

f71f8b5

jklymak approved these changes Apr 17, 2023

View reviewed changes

jklymak merged commit 690884f into matplotlib:main Apr 17, 2023

Higgs32584 deleted the documentation_1 branch April 18, 2023 12:56

eslothower pushed a commit to eslothower/matplotlib that referenced this pull request May 3, 2023

changed to RST (matplotlib#25594)

b5ed6db

Made user_explain/toolkits an rst-only gallery entry. Co-authored-by: Higgs32584 <[email protected]>

		@@ -0,0 +1,332 @@
		.. redirect-from:: /tutorials/toolkits/axes_grid


		Here you can find examples and explanations of how to use various toolkits available in Matplotlib.

		Axes Artist

Uh oh!

changed to RST #25594

changed to RST #25594

Uh oh!

Conversation

Higgs32584 commented Mar 31, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Mar 31, 2023

Uh oh!

Higgs32584 commented Mar 31, 2023

Uh oh!

Higgs32584 commented Mar 31, 2023

Uh oh!

tacaswell commented Mar 31, 2023

Uh oh!

Higgs32584 commented Mar 31, 2023

Uh oh!

jklymak commented Mar 31, 2023

Uh oh!

Higgs32584 commented Mar 31, 2023

Uh oh!

Higgs32584 commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Higgs32584 commented Mar 31, 2023

Uh oh!

ksunden commented Apr 1, 2023

Uh oh!

Higgs32584 commented Apr 1, 2023

Uh oh!

jklymak commented Apr 1, 2023

Uh oh!

Higgs32584 commented Apr 1, 2023

Uh oh!

Higgs32584 commented Apr 7, 2023

Uh oh!

jklymak commented Apr 9, 2023

Uh oh!

melissawm commented Apr 13, 2023

Uh oh!

Higgs32584 commented Apr 13, 2023

Uh oh!

melissawm commented Apr 13, 2023

Uh oh!

Higgs32584 commented Apr 13, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Higgs32584 Apr 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Higgs32584 commented Apr 17, 2023

Uh oh!

jklymak commented Apr 17, 2023

Uh oh!

jklymak left a comment

Choose a reason for hiding this comment

Uh oh!

rcomer commented Apr 18, 2023

Uh oh!

Higgs32584 commented Apr 18, 2023

Uh oh!

Higgs32584 commented Mar 31, 2023 •

edited

Loading

Higgs32584 Apr 13, 2023 •

edited

Loading