Skip to content

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

@musicinmybrain

Description

@musicinmybrain

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions