search

sphinx-doc / sphinx-argparse

A Sphinx extension to automatically document argparse commands and options
https://sphinx-argparse.readthedocs.org/
MIT License
26 stars 24 forks source link

Top-level "test" directory should not exist in site-packages #6

Closed dvzrv closed 1 year ago

dvzrv commented 2 years ago

Hi! When packaging 0.3.1 for Arch Linux I realized, that this package installs its test directory top-level into site-packages:

lstar python-sphinx-argparse-0.3.1-1-any.pkg.tar.zst
-rw-r--r-- root/root      5985 2021-12-04 00:06 .BUILDINFO
-rw-r--r-- root/root      2426 2021-12-04 00:06 .MTREE
-rw-r--r-- root/root       511 2021-12-04 00:06 .PKGINFO
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinx_argparse-0.3.1-py3.10.egg-info/
-rw-r--r-- root/root       391 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinx_argparse-0.3.1-py3.10.egg-info/PKG-INFO
-rw-r--r-- root/root       374 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinx_argparse-0.3.1-py3.10.egg-info/SOURCES.txt
-rw-r--r-- root/root         1 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinx_argparse-0.3.1-py3.10.egg-info/dependency_links.txt
-rw-r--r-- root/root        44 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinx_argparse-0.3.1-py3.10.egg-info/requires.txt
-rw-r--r-- root/root        15 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinx_argparse-0.3.1-py3.10.egg-info/top_level.txt
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/
-rw-r--r-- root/root        22 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__init__.py
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/
-rw-r--r-- root/root       169 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/__init__.cpython-310.opt-1.pyc
-rw-r--r-- root/root       169 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/__init__.cpython-310.pyc
-rw-r--r-- root/root     12235 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/ext.cpython-310.opt-1.pyc
-rw-r--r-- root/root     12235 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/ext.cpython-310.pyc
-rw-r--r-- root/root      8509 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/markdown.cpython-310.opt-1.pyc
-rw-r--r-- root/root      8509 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/markdown.cpython-310.pyc
-rw-r--r-- root/root      3679 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/parser.cpython-310.opt-1.pyc
-rw-r--r-- root/root      3679 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/__pycache__/parser.cpython-310.pyc
-rw-r--r-- root/root     22297 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/ext.py
-rw-r--r-- root/root     10191 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/markdown.py
-rw-r--r-- root/root      6663 2021-12-04 00:06 usr/lib/python3.10/site-packages/sphinxarg/parser.py
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/
-rw-r--r-- root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__init__.py
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/
-rw-r--r-- root/root       143 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/__init__.cpython-310.opt-1.pyc
-rw-r--r-- root/root       143 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/__init__.cpython-310.pyc
-rw-r--r-- root/root      1819 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/sample.cpython-310.opt-1.pyc
-rw-r--r-- root/root      1819 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/sample.cpython-310.pyc
-rw-r--r-- root/root       461 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/sample2.cpython-310.opt-1.pyc
-rw-r--r-- root/root       461 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/sample2.cpython-310.pyc
-rw-r--r-- root/root      7947 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/test_parser.cpython-310.opt-1.pyc
-rw-r--r-- root/root      7947 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/__pycache__/test_parser.cpython-310.pyc
-rw-r--r-- root/root      2062 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/sample.py
-rw-r--r-- root/root       256 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/sample2.py
-rw-r--r-- root/root     13755 2021-12-04 00:06 usr/lib/python3.10/site-packages/test/test_parser.py
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/share/
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/share/licenses/
drwxr-xr-x root/root         0 2021-12-04 00:06 usr/share/licenses/python-sphinx-argparse/
-rw-r--r-- root/root      1079 2021-12-04 00:06 usr/share/licenses/python-sphinx-argparse/LICENSE

This is a conflict waiting to happen and I need to remove the directory manually. Please make sure to either only ship the tests in the sdist tarball or add them below the sphinxarg package.

ashb commented 1 year ago

Fixed for next verstion.