readthedocs / readthedocs/sphinx-autoapi
test_symlink is broken from the sdist
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
It appears that tests/toctreeexample/example/example_2 is not part of the sdist tarball:
$ wget https://files.pythonhosted.org/packages/source/s/sphinx_autoapi/sphinx_autoapi-3.8.0.tar.gz
$ tar tf sphinx_autoapi-3.8.0.tar.gz | grep toctreeexample
sphinx_autoapi-3.8.0/tests/toctreeexample/conf.py
sphinx_autoapi-3.8.0/tests/toctreeexample/example/example.py
sphinx_autoapi-3.8.0/tests/toctreeexample/example_2/example_2.py
sphinx_autoapi-3.8.0/tests/toctreeexample/index.rst
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue by inspecting the sdist tarball and checking the missing tests/toctreeexample/example/example_2 path. Then inspect the project’s source-distribution configuration and the test_symlink coverage; done means the path is included in the sdist and test_symlink no longer fails from the unpacked archive.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, testing
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100