Commit Graph

4 Commits

Author SHA1 Message Date
Rodrigo Girão Serrão
914e50a70f Export types & doc improvements (#2329)
* Export types used in app.py

* Export more linked types/errors/classes.

* Remove custom template.

* Address review comments.

We need to have explicit 'Returns:' sections in properties if we want to link to the return type while https://github.com/mkdocstrings/python/issues/65 is open.

* Improve docs.
2023-05-02 15:12:53 +01:00
Will McGugan
2244b1161e api docs (#2240)
* api docs

* more docstrings

* logs

* docs shakeup

* fix notes, added intro to all apis

* Remove defaults to

* add note to events

* note

* use fira code
2023-04-08 15:35:49 +01:00
Will McGugan
6c958a1140 docs update (#2239)
* docs update

* class template

* no annotations in sig
2023-04-07 18:57:56 +01:00
Rodrigo Girão Serrão
fcba6ecaad Omit default values for attributes.
We copy the mkdocstrings template for attributes so that we can exclude the (default) value for attributes (and class variables) from the documentation as that is generally useless.
2023-01-25 11:41:05 +00:00