Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ jobs:
- name: Build documentation
run: uv run zensical build

- name: Resolve cross-references
run: uv run scripts/fix_autorefs.py

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
Expand Down
60 changes: 30 additions & 30 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,53 @@ This page is the entry point to the **complete** public API documentation.

## Collections

- [`Seq[T]`](reference/seq.md) — Immutable collections (tuple-backed)
- [`Vec[T]`](reference/vec.md) — Mutable collections (list-backed)
- [`Set[T]`](reference/set.md) — Immutable collections (frozenset-backed)
- [`SetMut[T]`](reference/setmut.md) — Mutable sets (set-backed)
- [`Dict[K, V]`](reference/dict.md) — Chainable dictionaries
- [`Seq[T]`][pyochain._iter.Seq] — Immutable collections (tuple-backed)
- [`Vec[T]`][pyochain._iter.Vec] — Mutable collections (list-backed)
- [`Set[T]`][pyochain._iter.Set] — Immutable collections (frozenset-backed)
- [`SetMut[T]`][pyochain._iter.SetMut] — Mutable sets (set-backed)
- [`Dict[K, V]`][pyochain._dict.Dict] — Chainable dictionaries

## Iterators

- [`Iter[T]`](reference/iter.md) — Lazy processing of iterators
- [`Peekable`](reference/peekable.md) — Peeking iterator
- [`Unzipped`](reference/unzipped.md) — Unzipped iterator results
- [`Iter[T]`][pyochain._iter.Iter] — Lazy processing of iterators
- [`Peekable`][pyochain._iter.Peekable] — Peeking iterator
- [`Unzipped`][pyochain._iter.Unzipped] — Unzipped iterator results

## Error handling

- [`Result[T, E]`](reference/result.md) — Explicit error handling (`Ok` / `Err`)
- [`Ok`](reference/ok.md)
- [`Err`](reference/err.md)
- [`ResultUnwrapError`](reference/resultunwraperror.md)
- [`Result[T, E]`][pyochain.rs.Result] — Explicit error handling (`Ok` / `Err`)
- [`Ok`][pyochain.rs.Ok]
- [`Err`][pyochain.rs.Err]
- [`ResultUnwrapError`][pyochain.rs.ResultUnwrapError]

## Optional values

- [`Option[T]`](reference/option.md) — Optional values (`Some` / `NONE`)
- [`Some`](reference/some.md)
- [`None`](reference/noneoption.md)
- [`OptionUnwrapError`](reference/optionunwraperror.md)
- [`Option[T]`][pyochain.rs.Option] — Optional values (`Some` / `NONE`)
- [`Some`][pyochain.rs.Some]
- [`None`][pyochain.rs.NoneOption]
- [`OptionUnwrapError`][pyochain.rs.OptionUnwrapError]

## Traits & mixins

### Fluent Traits

- [`Pipeable`](reference/pipeable.md) — `.into()`, `.inspect()`
- [`Checkable`](reference/checkable.md) — `.then()`, `.ok_or()`, ...
- [`Pipeable`][pyochain.rs.Pipeable] — `.into()`, `.inspect()`
- [`Checkable`][pyochain.rs.Checkable] — `.then()`, `.ok_or()`, ...

### Abstract Collection Traits

- [`PyoIterable[T]`](reference/pyoiterable.md) — Base trait for all iterables
- [`PyoIterator[T]`](reference/pyoiterator.md) — Iterator trait
- [`PyoCollection[T]`](reference/pyocollection.md) — Base trait for eager collections
- [`PyoSequence[T]`](reference/pyosequence.md) — Sequence trait
- [`PyoMutableSequence[T]`](reference/pyomutablesequence.md) — Mutable sequence trait
- [`PyoSet[T]`](reference/pyoset.md) — Set trait
- [`PyoMappingView[T]`](reference/pyomappingview.md) — Mapping view trait
- [`PyoMapping[K, V]`](reference/pyomapping.md) — Mapping trait
- [`PyoMutableMapping[K, V]`](reference/pyomutablemapping.md) — Mutable mapping trait
- [`PyoIterable[T]`][pyochain.traits._iterable.PyoIterable] — Base trait for all iterables
- [`PyoIterator[T]`][pyochain.traits._iterable.PyoIterator] — Iterator trait
- [`PyoCollection[T]`][pyochain.traits._iterable.PyoCollection] — Base trait for eager collections
- [`PyoSequence[T]`][pyochain.traits._iterable.PyoSequence] — Sequence trait
- [`PyoMutableSequence[T]`][pyochain.traits._iterable.PyoMutableSequence] — Mutable sequence trait
- [`PyoSet[T]`][pyochain.traits._iterable.PyoSet] — Set trait
- [`PyoMappingView[T]`][pyochain.traits._iterable.PyoMappingView] — Mapping view trait
- [`PyoMapping[K, V]`][pyochain.traits._iterable.PyoMapping] — Mapping trait
- [`PyoMutableMapping[K, V]`][pyochain.traits._iterable.PyoMutableMapping] — Mutable mapping trait

### Mapping Views

- [`PyoKeysView[K]`](reference/pyokeysview.md) — Keys view
- [`PyoValuesView[V]`](reference/pyovaluesview.md) — Values view
- [`PyoItemsView[K, V]`](reference/pyoitemsview.md) — Items view
- [`PyoKeysView[K]`][pyochain.traits._iterable.PyoKeysView] — Keys view
- [`PyoValuesView[V]`][pyochain.traits._iterable.PyoValuesView] — Values view
- [`PyoItemsView[K, V]`][pyochain.traits._iterable.PyoItemsView] — Items view
Loading