Re: [sphinx-users] Re: Summaries of module contents at top of each module html, done automatically

2021-05-01 Thread Komiya Takeshi
There is no good way to register the classes and functions to ToC. Please generate a section for each entry as a workaround. Thanks, Takeshi KOMIYA 2021年5月2日(日) 0:22 Carl Gay : > > I'm also looking for this. Essentially I want what http://golang.org/pkg/ > has, where if you click through to one

Re: [sphinx-users] Re: intersphinx -- how does mapping find domain name?

2021-05-01 Thread Komiya Takeshi
Hi, The intersphinx basically works transparently. It automatically converts cross-references to remote references if the reference target not found locally. A reference :py:class:`zipfile.ZipFile` will be converted to a) a local reference if local document has an entry for zipfile.ZipFile, or b)

[sphinx-users] Re: Summaries of module contents at top of each module html, done automatically

2021-05-01 Thread Carl Gay
I'm also looking for this. Essentially I want what http://golang.org/pkg/ has, where if you click through to one of the (auto-generated) packages, for example bytes , you can see the entire public API at a glance. From the Sphinx perspective I think this would mean

[sphinx-users] Re: intersphinx -- how does mapping find domain name?

2021-05-01 Thread Carl Gay
Just noticed this was never answered, so to close the loop... It turns out I just had the wrong syntax for the references. This works: :func:`http:add-resource`, where "http" is one of the keys in the intersphinx_mapping config and "add-resource" is the name of a function in that document. On