[issue46109] Separate resources and abc docs from other importlib docs

Jason R. Coombs added the comment: As I'm exploring this issue, I notice that currently, the docs refer to :class:`importlib.resources.abc.Traversable` (even though that doesn't currently exist) (https://github.com/python/cpython/blame/main/Doc/library/importlib.rst#L948). --

[issue46109] Separate resources and abc docs from other importlib docs

Jason R. Coombs added the comment: > a ToC at the top of the main page which identifies the submodules (and > provides a brief summary for each) would be extra helpful. I've added this in the latest commit (1adefaf552). -- ___ Python tracker

[issue46109] Separate resources and abc docs from other importlib docs

Jason R. Coombs added the comment: The reason I wanted to consider issue46118 first was because I wanted to explore whether the ABCs from `importlib_resources.abc` should be _documented_ as `importlib.resources.abc` or `importlib.abc` (as they are now). After filing the issue and exploring

[issue46109] Separate resources and abc docs from other importlib docs

Jason R. Coombs added the comment: I wonder if maybe it's more important to address issue46118 first. -- ___ Python tracker ___

[issue46109] Separate resources and abc docs from other importlib docs

Jason R. Coombs added the comment: My main motivation for moving `.abc` was because it contains classes exclusively relevant to `.resources` (those also present in `importlib_resources.abc`. I want to explore moving those classes to the resources documentation so they're available together

[issue46109] Separate resources and abc docs from other importlib docs

Eric Snow added the comment: FWIW, one benefit to having everything in one doc (instead of one doc per submodule) is that it's a little easier to see the bigger picture. This is particularly important for folks interested in customizing the import system (rather than just interacting with

[issue46109] Separate resources and abc docs from other importlib docs

Eric Snow added the comment: +1 to splitting out the importlib.resources docs I'm mostly +1 for splitting out the others (.abc, .machinery, .util) too, not just .abc. Regardless, a ToC at the top of the main page which identifies the submodules (and provides a brief summary for each) would

[issue46109] Separate resources and abc docs from other importlib docs

Change by Jason R. Coombs : -- keywords: +patch pull_requests: +28379 stage: -> patch review pull_request: https://github.com/python/cpython/pull/30160 ___ Python tracker ___

[issue46109] Separate resources and abc docs from other importlib docs

New submission from Jason R. Coombs : The `importlib` documentation is fairly long and covers a number of topics. Furthermore, the `importlib.metadata` is separately documented and presents a good example of breaking out major aspects. Let's do the same with `.abc` and `.resources`.