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

use the python default gitignore #179

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Conversation

12rambau
Copy link
Contributor

@12rambau 12rambau commented Oct 2, 2024

I simply used the python global gitignore and removed everything related to the wheel builder that are not related to this project (namely poetry, hatch, pdm) and things related to pycharm.

I added back the MacOs .DS_Store at the bottom.

I did this because in another PR I added stuff related to nox and all folder went in the last commit. I think it cost nothing to have a wider gitignore and make sure that new tools can be brought to the package without ignore issues.

I simply used the python global gitignore and removed everything related to the wheel builder that are not related to this project (namely poetry, hatch, pdm) and things related to pycharm. 

I added back the MacOs `.DS_Store` at the bottom. 

I did this because in another PR I added stuff related to nox and all folder went in the last commit. I think it cost nothing to have a wider gitignore and make sure that new tools can be brought to the package without ignore issues.
@jdbcode
Copy link
Member

jdbcode commented Oct 2, 2024

No objections from me, except can you make sure that this does not remove things that aren't included in the template, for example I don't think I saw docs/source/_autosummary or docs/*.zarr, which I assume were added for a reason.

(Note: template source is https://github.com/github/gitignore/blob/main/Python.gitignore, supported by the GitHub team)

@12rambau
Copy link
Contributor Author

12rambau commented Oct 3, 2024

@jdbcode I'm planning to move away from autosummary in the documentation framework and use the more modern autoapi from RDT instead so I think it's not a problem

@jdbcode
Copy link
Member

jdbcode commented Oct 3, 2024

Sounds good. I still wonder about docs/*.zarr - do you know what generates this and if it is important to ignore.

@12rambau
Copy link
Contributor Author

12rambau commented Oct 4, 2024

No idea, the documentation I build in the other PR didin't created any of them. My guess is that the old implementation of the docs was not storing all the output in a dedicated docs/_build folder. So even if they are still there, starting from #177 they will systematically get ignored with the rest of the doc build artifcats.

@jdbcode jdbcode self-requested a review October 4, 2024 15:15
@copybara-service copybara-service bot merged commit 5f8e213 into google:main Oct 4, 2024
6 of 11 checks passed
@12rambau 12rambau deleted the patch-3 branch October 5, 2024 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants