Skip to content

Commit

Permalink
Generate docs (#13)
Browse files Browse the repository at this point in the history
Fixes #12
  • Loading branch information
chuckwondo authored Aug 16, 2024
1 parent 10e3cf2 commit 27ac382
Show file tree
Hide file tree
Showing 4 changed files with 512 additions and 12 deletions.
4 changes: 4 additions & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
title: API Reference
nav:
- Overview: README.md
- ...
23 changes: 23 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- markdownlint-disable -->

# API Overview

## Modules

- [`maybe`](./maybe.md#module-maybe)

## Classes

- [`maybe.Nothing`](./maybe.md#class-nothing): An object that indicates no inner value is present
- [`maybe.Some`](./maybe.md#class-some): An object that indicates some inner value is present
- [`maybe.UnwrapError`](./maybe.md#class-unwraperror): Exception raised from ``.unwrap_<...>`` and ``.expect_<...>`` calls.

## Functions

- [`maybe.is_nothing`](./maybe.md#function-is_nothing): A typeguard to check if a maybe is a `Nothing`.
- [`maybe.is_some`](./maybe.md#function-is_some): A typeguard to check if a maybe is a `Some`.


---

_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._
Loading

0 comments on commit 27ac382

Please sign in to comment.