search

Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
0 stars 7 forks source link

Fix docs.yml #77

Closed cadenmyers13 closed 3 weeks ago

cadenmyers13 commented 3 weeks ago

closes #17

Screen Shot 2024-06-25 at 10 47 11 AM Screen Shot 2024-06-25 at 10 47 51 AM
cadenmyers13 commented 3 weeks ago

@cadenmyers13 I think in this case the diff file should show virtually no changes over what is in diffpy.utils, so I am a bit worried about this. It looks like the doc build is being handled very differently. Did you discuss this with @Sparks29032 and that is why it is like this? For example, I think we only want to build on push, but there are many other differences that probably we may not want.

One change we may want is to pick a python version dynamically from cookiecutter.

No we didn't discuss this. I checked out docs.yml in the original diffpy.utils on my browser just to make sure and it had all the same differences as the edits I made in this PR...

sbillinge commented 3 weeks ago

if the edits in the cookie cutter look like those in the diffpy.utils, then there should be no changes in the diff. Please can you check that you are doing the diff workflow correctly?

cadenmyers13 commented 3 weeks ago

Maybe I'm missing the point. The edits I made are consistent with docs.yml in diffpy.utils. So when I copy docs.yml from the original diffpy.utils into the diffpy.utils made by the cookiecutter and run git diff, I should see all the differences shown in the screenshot right? This is the docs.yml in the current cookiecutter.

cadenmyers13 commented 3 weeks ago

I just talked with Tieqiong and I was sending the wrong git diff lol... I think i figured it out. One sec...

cadenmyers13 commented 3 weeks ago

@sbillinge okay, after making the edits outlined in the above screenshot, I ran the cookiecutter. Comparing docs.yml in diffpy.utils made by the cookiecutter and the original, I am getting no differences. Is this what you mean? Screen Shot 2024-06-25 at 12 06 39 PM

Sparks29032 commented 3 weeks ago

LGTM, also ran a git diff. However, note that PR #48 also adds this file, so we may not need to merge this.

sbillinge commented 3 weeks ago

@sbillinge okay, after making the edits outlined in the above screenshot, I ran the cookiecutter. Comparing docs.yml in diffpy.utils made by the cookiecutter and the original, I am getting no differences. Is this what you mean? Screen Shot 2024-06-25 at 12 06 39 PM

yes, nailed it. Well done. This is what we are after. Per @Sparks29032 unfortunately this is duplicate and is also on another PR, so I will wait to merge it. But thanks so much for getting this to here.

sbillinge commented 3 weeks ago

@cadenmyers13 I was able to merge the other PR ok, so I am just closing this one. So sorry for the duplicated effort, but thanks. At least it helped you polish the diff workflow!