Add an automodule directive

[erikrose]

It should probably limit itself to the exported symbols by default, just as py:automodule respects __all__.

[erikrose]

This is probably just a matter of taking a filepath suffix and spinning through the doclets that are from that (disambiguated) file.

[erikrose]

More specifically, we'd need (as Loïc has guessed) a new directive, a new renderer for that directive which delegates to the other directives the way AutoClassRenderer._members_of() does, and then probably a new SuffixTree built up in doclets.py which indexes doclets by file path. That way, we'll be able to use any unambiguous file path segment to refer to a "module" (since JS doesn't really have a standard way of mapping module names to file paths):

.. automodule:: foo
.. automodule:: specific/foo
.. automodule:: ./more/specific/foo

[loichuder]

I tried to give a go at the implementation of this:

• I added the AutoModule directive in directives.py
• I also added a AutoModuleRenderer on the same model as AutoClassRenderer.

I am still a bit shaky on the Renderer tho.

I understood that it needs a sphinx_doclets_by_module tree where the first rank of keys must be filepaths (as you said, Erik). But then it means that, to render this, we cannot use directly the rst_nodes method (as in other renderers) as it takes an object name (and not a path) as arg.
I suppose that I need to go through the new module tree by paths to extract object names but I do not know where and how to implement this efficiently.

[erikrose]

Looking only broadly at the code, I would guess we need to add a collection in doclets.gather_doclets(), as you supposed. I'd gather a SuffixTree where file paths point to lists of top-level doclets from that file. Then AutoModuleRenderer can loop up the file key then loop through the doclets.

[chalbersma]

Did this effort peter out?