Skip to content

Commit

Permalink
Put all of API onto one page in docs, fix how we show crowsetta.examp…
Browse files Browse the repository at this point in the history
…les.show and crowsetta.example
  • Loading branch information
NickleDave committed Oct 12, 2024
1 parent 25d4e08 commit 929be20
Show file tree
Hide file tree
Showing 4 changed files with 181 additions and 197 deletions.
121 changes: 0 additions & 121 deletions doc/api/core.md

This file was deleted.

20 changes: 0 additions & 20 deletions doc/api/formats.md

This file was deleted.

195 changes: 181 additions & 14 deletions doc/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,189 @@ This section documents the
[API](https://en.wikipedia.org/wiki/API)
of crowsetta.

```{list-table}
:widths: 30 70
(api-core)=

* - {ref}`Core <api-core>`
- The core data types, classes and modules of crowsetta
* - {ref}`Interface <api-interface>`
- Defines an interface for classes that represent annotation formats
* - {ref}`Formats <api-formats>`
- Modules with the classes representing annotation formats,
and functions for conveniently accessing them.
# Core

This section documents the core API of crowsetta,
including data types, other classes, and modules.

## Data types

### Annotation

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.Annotation
```

### Sequence

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.Sequence
```

### Segment

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.Segment
```

### BBox

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.BBox
```

## Classes

### Transcriber

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.Transcriber
```

## Modules

### `crowsetta.interface`

For complete documentation of the interface,
please see {ref}`this page <api-interface>`.

```{eval-rst}
.. autosummary::
:toctree: generated
:template: module.rst
crowsetta.interface
```

```{toctree}
:hidden: true

core
interface
formats
### typing

```{eval-rst}
.. autosummary::
:toctree: generated
:template: module.rst
:recursive:
crowsetta.typing
```


### validation

```{eval-rst}
.. autosummary::
:toctree: generated
:template: module.rst
:recursive:
crowsetta.validation
```

## Decorators

### `crowsetta.register_format`

```{eval-rst}
.. autosummary::
:toctree: generated
crowsetta.register_format
```

## Example data

```{eval-rst}
.. autosummary::
:toctree: generated
crowsetta.example
crowsetta.examples.show
```

(api-formats)=

# Formats

This section documents the API of the :mod:`crowsetta.formats` module.
It is generated automatically.
If you are a crowsetta user looking for
more detail about the built-in formats,
please see: {ref}`formats-index`.

```{eval-rst}
.. autosummary::
:toctree: generated
:template: module.rst
:recursive:
crowsetta.formats
crowsetta.formats.bbox
crowsetta.formats.seq
```

(api-interface)=

# Interface

The section documents the API of the :mod:`crowsetta.interface` module.

```{eval-rst}
.. autosummary::
:toctree: generated
:template: module.rst
:recursive:
crowsetta.interface
```

## Base

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.interface.base.BaseFormat
```

## Sequence-Like

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.interface.seq.SeqLike
```

## Bounding Box-Like

```{eval-rst}
.. autosummary::
:toctree: generated
:template: class.rst
crowsetta.interface.bbox.BBoxLike
```
42 changes: 0 additions & 42 deletions doc/api/interface.md

This file was deleted.

0 comments on commit 929be20

Please sign in to comment.