[Docs] Add more examples to MANIFEST.in explanation

Open
#4,158 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the using-manifest-in guide linked in the issue and review its current MANIFEST.in examples. Add examples explaining recursive-include with a file pattern, including the folder and parent/folder cases described, then verify the documentation clearly distinguishes valid usage from the examples that do not work.

Written by the indexing model from the issue text.

Description

documentation Needs Triage
Summary

I'm migrating https://github.com/pypa/packaging.python.org/issues/989 since the relevant document has moved here with #4108.

Posted by @shi-yan:

"""
this is a poor document regarding manifest.in usage.

https://packaging.python.org/guides/using-manifest-in/

for example it doesn't contain any example for using recursive-include

recursive-include folder
recursive-include parent/folder

don't work at all.

it has to be

recursive-include folder *.html

"""

OS / Environment

No response

Additional Information

Examples should be added.

Code of Conduct
  • I agree to follow the PSF Code of Conduct
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pypa/setuptools

All issues in pypa/setuptools

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.