Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs (replaces #7) #13

Merged
merged 1 commit into from
Aug 16, 2024
Merged

Generate docs (replaces #7) #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docs/.pages
View file
Open in desktop
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
View file
Open in desktop
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