Documentation of pip's internals · Issue #6831 · pypa/pip (original) (raw)

This is only for developers and contributors. Using pip's internals from third party projects is not and, for the foreseeable future, will not be a supported way of using pip.

Here's how I'd planned to structure it while working on the overall architecture docs, at PyCon 2019:

• add development/architecture/ to the html documentation
• index is a table of contents + a 1 or 2 paragraph overview + a note that pip's internals are not for external consumers but maintainers and contributors.
• each component within the codebase can get its own dedicated page/section within that as necessary.
  • think download, finder, vcs, build, install, configuration, uninstall, resolution etc.
  • Example url: development/architecture/download.html
• A contributor friendly guide that connects the dots for all these parts.

Originally posted by @pradyunsg in #6787 (comment)