Add more details to sphinx-generated API reference

[Markus Löning]

Hi all, 

Currently, when we generate our API reference we basically get a table with two columns, one for the class name and one for the description (the first line of the init docstring) (see https://sktime.org/api_reference.html)

Is there a way to add another column to it? 

We'd like to display the GitHub handle of the author/maintainer of the class to make it easier for people to contact the right person and to give our authors/maintainer more visibility. 

Could we use __author__ information in the Python files for that? 

Thanks for your help

Markus

[Komiya Takeshi]

It seems this pages uses autosummary extension. If so, there no way to
add table columns for autosummary-table.
You need to make a your own custom directive.

Thanks,
Takeshi KOMIYA

2020年8月3日(月) 19:26 Markus Löning <markus...@gmail.com>:

> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/666ab01f-cadb-495c-ad63-7b78ab4ef857o%40googlegroups.com.

[Markus Löning]

Thanks Takeshi for the reply. Any other way to do this with sphinx if we would give up the auto summary extension?

On Monday, 3 August 2020 14:55:32 UTC+1, Komiya Takeshi wrote:

It seems this pages uses autosummary extension. If so, there no way to
add table columns for autosummary-table.
You need to make a your own custom directive.

Thanks,
Takeshi KOMIYA

2020年8月3日(月) 19:26 Markus Löning <markus...@gmail.com>:
>
> Hi all,
>
> Currently, when we generate our API reference we basically get a table with two columns, one for the class name and one for the description (the first line of the init docstring) (see https://sktime.org/api_reference.html)
>
> Is there a way to add another column to it?
>
> We'd like to display the GitHub handle of the author/maintainer of the class to make it easier for people to contact the right person and to give our authors/maintainer more visibility.
>
> Could we use __author__ information in the Python files for that?
>
> Thanks for your help
>
> Markus
>
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.

> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx...@googlegroups.com.

[Komiya Takeshi]

Sorry. I don't know that. There many kinds of extensions in the world.
So there might be an expected one.

Thanks,
Takeshi KOMIYA

2020年8月3日(月) 22:57 Markus Löning <markus...@gmail.com>:

> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/ba625903-7184-43ce-9981-ca0be61e567eo%40googlegroups.com.

[Daniel Scott]

--

You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/666ab01f-cadb-495c-ad63-7b78ab4ef857o%40googlegroups.com.