added support for nested classes; this is basically a newer version o…

[frank101010]

Adds support for nested classes to pdoc3.

This is basically a newer version of angeloskath's commit 467350c, #176, but since I need support for nested classes, and the original merge request hasn't changed status since June 2020, I decided to apply most of angeloskath's changes into a branch derived from the most recent master.

(deleted section about unit test problems, which were resolved after running tests on an os supporting symbolic links)

[kernc]

Thanks for bringing this up again!

Would you care to add a small unit test to show this new feature works as advertised and so we don't break it later?

[frank101010]

@kernc: you might want to wait with the next review, I've discovered a problem regarding warnings being issued, which I've already resolved. But there are also cases where member types are not properly rendered as hyperlinks in html output. The latter problem is due to the usage of inspect.formatannotations(), which does not format built-in container types like dict[str, int] properly (works with typing.Dict[str. int], though); but I'm going to create a new pull request for this.

[frank101010]

@kernc: I just pushed new changes which fix a problem nested classes being recognized as pdoc.External instead of pdoc.Class. This required adding the nested classes into pdoc.Module's context. Unfortunately, this also breaks one unit test, namely ApiTest.test__all__. Since I don't really understand how that test works, could you please have a look at it?

[kernc]

The test tries to ensure that only the identifiers in __all__ are exposed. Interestingly, I'm not sure where the value 'B.B.C' comes from. I'd understand 'B.C' since that's what's nested. 🤔

pdoc/pdoc/test/example_pkg/__init__.py

Lines 111 to 112 in 2cce30a

	class C:
	"""B.C docstring"""

[JPHutchins]

@frank101010 @kernc Is this good to go? I require this functionality and can work on the PR by reopening on my own fork if you don't have time.

Thanks,
JP