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

Remove "Using MANIFEST.in" guide, moved to setuptools docs #1377

Merged
merged 2 commits into from
Nov 18, 2023

Conversation

jeanas
Copy link
Contributor

@jeanas jeanas commented Nov 11, 2023

This page: https://packaging.python.org/en/latest/guides/using-manifest-in/ is very setuptools-specific, describing the syntax of setuptools' MANIFEST.in file. I think the setuptools documentation is a better home for this. I've opened a PR on the setuptools repo to add it. Once it's merged, this PR can be undrafted and merged. It removes the document, which should be replaced by a redirect in the ReadTheDocs configuration.


📚 Documentation preview 📚: https://python-packaging-user-guide--1377.org.readthedocs.build/en/1377/

@jeanas jeanas marked this pull request as ready for review November 16, 2023 18:46
@jeanas
Copy link
Contributor Author

jeanas commented Nov 16, 2023

The setuptools PR has been merged, so this is now ready.

@abravalheri
Copy link
Contributor

I was wondering if it would be possible to add a HTTP redirect instead of removing1... This way any existing links in places other than the setuptools docs themselves (thanks Jean) would still "work".

In setuptools, I use sphinx-reredirects in a couple of places to achieve something similar.

Footnotes

  1. I mean just for direct access to the webpage address itself. Removing from any ToC is completely fine.

@jeanas
Copy link
Contributor Author

jeanas commented Nov 17, 2023

@abravalheri This is what I wrote in the PR description:

Once it's merged, this PR can be undrafted and merged. It removes the document, which should be replaced by a redirect in the ReadTheDocs configuration.

The PUG uses redirects configured from the RTD Web UI instead of sphinx-reredirects.

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that we have been creating orphan stubs instead of completely removing docs.

@sinoroc
Copy link
Contributor

sinoroc commented Nov 17, 2023

The PUG uses redirects configured from the RTD Web UI instead of sphinx-reredirects.

Why? Seems like we are locking ourselves to RTD for no reason.

I asked on some other thread but it might be a bit hidden, forgive me for asking again...

@jeanas
Copy link
Contributor Author

jeanas commented Nov 17, 2023

I believe that we have been creating orphan stubs instead of completely removing docs.

You are right, I was already forgetting about @pradyunsg's concerns on redirecting to a different domain (at least as long as documatt/sphinx-reredirects#6 isn't merged).

@jeanas
Copy link
Contributor Author

jeanas commented Nov 17, 2023

Fixed. Sorry for the misstep.

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update @jeanas.

@willingc willingc added this pull request to the merge queue Nov 18, 2023
@willingc
Copy link
Contributor

@sinoroc I think @pradyunsg would be better to respond to your question.

Merged via the queue into pypa:main with commit 3596c12 Nov 18, 2023
5 checks passed
@pradyunsg
Copy link
Member

Filed #1408 which, I think makes it easier to track the RtD redirects if we're going to be adding them for anything or already have a bunch.

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

Successfully merging this pull request may close these issues.

5 participants