Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
YooSunYoung committed Dec 13, 2024
1 parent 297f7ee commit 0f187b2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/api-reference/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
# API Reference

## Classes

## Protocols and Mixins
Application interface protocols and matching mixins.
```{eval-rst}
.. currentmodule:: appstract
.. currentmodule:: appstract.protocols
.. autosummary::
:toctree: ../generated/classes
:template: class-template.rst
:recursive:
LoggingProtocol
LogMixin
```

## Top-level functions
## Free Functions

```{eval-rst}
.. currentmodule:: appstract.schedulers
.. autosummary::
:toctree: ../generated/functions
:recursive:
async_retry
retry
```

## Submodules
Expand All @@ -26,4 +35,9 @@
:toctree: ../generated/modules
:template: module-template.rst
:recursive:
constructors
logging
schedulers
```
1 change: 1 addition & 0 deletions docs/developer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ maxdepth: 2
getting-started
coding-conventions
dependency-management
async-programming
```

0 comments on commit 0f187b2

Please sign in to comment.