sphinx-doc / alabaster

Lightweight, configurable Sphinx theme
http://alabaster.readthedocs.io/
Other
734 stars 186 forks source link

Customizing the default templates for class attributes and methods, and examples #160

Open johannfaouzi opened 5 years ago

johannfaouzi commented 5 years ago

Hi,

First of all, I would like to thank you for this awesome template, it's very nice and the customization is really helpful. I am trying to move the documentation of one of my projects to this template, and there are a couple of things that I am unable to do. I hope that it is fine to ask it here.

Adding a list of all the methods available for a given class

Here is an example from the Bootstrap template. I find it very helpful to have this kind of table, especially when a class has many methods.

Moving the Attributes section higher, right after the Parameters section

Here is an example from scikit-learn. I find it more intuitive to have the Attributes section right after the Parameters section.

Adding hyperlinks to the example images

Here is an example. This is done with the Bootstrap, Sphinx_RTD and scikit-learn themes. I also find it more intuitive to click on the image rather than on the title below.

Thank you for very much for your help.