test doc rendering

[fredrik-1]

Work in progress. I am testing a couple of ways to render the documentation. Issue for discussion appear soon.

Test to see if automodapi are installed on CircleCi and to show the results if it is.

I am testing the transforms module. The result looks ok on my computer.

edit: The same problems with the docstrings with :: in the first line again. I fix it tomorrow.

Ok, automodapi was not installed. I guess that could be fixed by someone. The extension is definitely useful but probable not the best option for all modules.

[ImportanceOfBeingErnest]

I guess you need to add sphinx-automodapi to the doc-requirements.txt.

[fredrik-1]

So here is the results for the options used. Some comments:

• I am not sure if attributes should be included in the documentation but I don't think that it exist an option to not include them.
• Some of the methods appears twice in the methods documentation .
• Some methods don't have a link to the source code.

update: I saw that it exist a directive automodsumm in automodapi that is supposed to work like autosummary but with automatic rendering. It doesn't seem to work with templates at the moment though but with a few changes I got the expected result. Lets see if it can be fixed in the automodapi module.

I believe that that the automodsumm directive is exactly what we want.

[jklymak]

I'm closing this, but feel free to re-open if you want to move forward...

[timhoffm]

I think some more standard way and improved layout is still needed. OTOH we have different types of code in modules (many small classes, extremely large classes, many module-level functions). They probably need different layouts (as they now more or less manually have).

Not reopening now, but the topic itself is still relevant.