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

Unbind the documentation from distutils #9

Closed
2 tasks done
arhadthedev opened this issue Jul 25, 2022 · 4 comments
Closed
2 tasks done

Unbind the documentation from distutils #9

arhadthedev opened this issue Jul 25, 2022 · 4 comments
Assignees

Comments

@arhadthedev
Copy link
Owner

arhadthedev commented Jul 25, 2022

python#85454 (comment):

If you like to help, then you could start with updating our documentation. You could update the "distributing" section to refer to setuptools and PyPA packaging instead of distutils. There are also references to :mod:`distutils` and various functions in the distutils namespace in the whatsnew. They have to be replaced by ``distutils``, too.

It gives the following targets:

@arhadthedev arhadthedev self-assigned this Jul 25, 2022
@merwok
Copy link

merwok commented Jul 25, 2022

Replace distutils-based documentation with setuptools-based one (TBD).

Do you mean making very short documents that point to setuptools / packaging docs, or rewriting docs in CPython repo with lots of setuptools specifics?

@arhadthedev
Copy link
Owner Author

I planned to use the second approach since small hyperlinked chunks are hard to read. However, I need to educate myself on how setuptools work in the first place (if the rewriting issue is of a low priority), or give it up to someone with packaging experience if it's more urgent.

@merwok
Copy link

merwok commented Jul 25, 2022

I don’t think CPython docs should be full of info referencing a third-party project.
I would keep the files (because of all the existing links that point there), include a disclaimer about distutils being removed, and link to packaging.python.org and sometimes maybe setutpools docs.

This may need a discussion with a bigger audience on python-dev or packaging discuss.

@arhadthedev
Copy link
Owner Author

The setuptools references seem to be addressed by Christian in python#95239 and pending PRs (Some examples like zipapp need to be updated later.). Closing as done on my side.

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

No branches or pull requests

2 participants