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

Unnecessary file nifti_mrs/standard/explanatory_doc/conf.py #24

Closed
musicinmybrain opened this issue Apr 2, 2024 · 0 comments · Fixed by #25
Closed

Unnecessary file nifti_mrs/standard/explanatory_doc/conf.py #24

musicinmybrain opened this issue Apr 2, 2024 · 0 comments · Fixed by #25

Comments

@musicinmybrain
Copy link
Contributor

An unnecessary file nifti_mrs/standard/explanatory_doc/conf.py, the Doxygen configuration for the standard specification https://github.com/wtclarke/mrs_nifti_standard/, is included in both the sdists and wheels, when only nifti_mrs/standard/definitions.json is really needed or wanted. This isn’t particularly harmful, but it isn’t really right either.

$ python3.12 -m venv _e
$ . _e/bin/activate
(_e) $ pip install nifti-mrs
(_e) $ find _e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/definitions.json
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc/conf.py
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc/__pycache__
_e/lib/python3.12/site-packages/nifti_mrs/standard/explanatory_doc/__pycache__/conf.cpython-312.pyc
$ gh repo clone wtclarke/nifti_mrs_tools
$ cd nifti_mrs_tools
$ python3 -m build
$ tar -tzf dist/nifti_mrs-1.2.0.tar.gz | grep standard
nifti_mrs-1.2.0/src/nifti_mrs/standard/
nifti_mrs-1.2.0/src/nifti_mrs/standard/definitions.json
nifti_mrs-1.2.0/src/nifti_mrs/standard/explanatory_doc/
nifti_mrs-1.2.0/src/nifti_mrs/standard/explanatory_doc/conf.py

Expected:

$ python3.12 -m venv _e
$ . _e/bin/activate
(_e) $ pip install nifti-mrs
(_e) $ find _e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/
_e/lib/python3.12/site-packages/nifti_mrs/standard/definitions.json
$ tar -tzf dist/nifti_mrs-1.2.0.tar.gz | grep standard
nifti_mrs-1.2.0/src/nifti_mrs/standard/
nifti_mrs-1.2.0/src/nifti_mrs/standard/definitions.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant