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

A “doc” directory is installed directly in site-packages #877

Closed
1 task done
musicinmybrain opened this issue Nov 3, 2023 · 0 comments
Closed
1 task done

Comments

@musicinmybrain
Copy link
Contributor

ALL software version info

param 2.0.0; nothing else matters here

Description of expected behavior and the observed behavior

Some of the documentation is installed in a doc directory in site-packages, as if it were a Python package.

Complete, minimal, self-contained example code that reproduces the issue

python3.12 -m venv _e
. _e/bin/activate
pip install param
find _e/lib/python3.12/site-packages/doc/
_e/lib/python3.12/site-packages/doc/
_e/lib/python3.12/site-packages/doc/reference
_e/lib/python3.12/site-packages/doc/reference/param
_e/lib/python3.12/site-packages/doc/reference/param/index.md
_e/lib/python3.12/site-packages/doc/reference/param/logging.md
_e/lib/python3.12/site-packages/doc/reference/param/param_namespace.md
_e/lib/python3.12/site-packages/doc/reference/param/parameter_helpers.md
_e/lib/python3.12/site-packages/doc/reference/param/parameterized_helpers.md
_e/lib/python3.12/site-packages/doc/reference/param/parameterized_objects.md
_e/lib/python3.12/site-packages/doc/reference/param/parameters.md
_e/lib/python3.12/site-packages/doc/reference/param/reactive.md
_e/lib/python3.12/site-packages/doc/reference/param/serialization.md

Alternatively, working in a clean git checkout:

python3 -m build
python3 -m wheel unpack dist/param-*.whl
find param-*/doc/

Stack traceback and/or browser JavaScript console output

N/A

Screenshots or screencasts of the bug in action

N/A

  • I may be interested in making a pull request to address this

I think this can be fixed by adding exclude = ["doc"] to [tool.hatch.build.targets.wheel] in pyproject.toml.

musicinmybrain added a commit to musicinmybrain/param that referenced this issue Nov 3, 2023
@maximlt maximlt closed this as completed in e9b2781 Nov 6, 2023
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

No branches or pull requests

1 participant