Skip to content

Commit 27ac382

Browse files
authored
Generate docs (#13)
Fixes #12
1 parent 10e3cf2 commit 27ac382

File tree

4 files changed

+512
-12
lines changed

4 files changed

+512
-12
lines changed

docs/.pages

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: API Reference
2+
nav:
3+
- Overview: README.md
4+
- ...

docs/README.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- markdownlint-disable -->
2+
3+
# API Overview
4+
5+
## Modules
6+
7+
- [`maybe`](./maybe.md#module-maybe)
8+
9+
## Classes
10+
11+
- [`maybe.Nothing`](./maybe.md#class-nothing): An object that indicates no inner value is present
12+
- [`maybe.Some`](./maybe.md#class-some): An object that indicates some inner value is present
13+
- [`maybe.UnwrapError`](./maybe.md#class-unwraperror): Exception raised from ``.unwrap_<...>`` and ``.expect_<...>`` calls.
14+
15+
## Functions
16+
17+
- [`maybe.is_nothing`](./maybe.md#function-is_nothing): A typeguard to check if a maybe is a `Nothing`.
18+
- [`maybe.is_some`](./maybe.md#function-is_some): A typeguard to check if a maybe is a `Some`.
19+
20+
21+
---
22+
23+
_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._

0 commit comments

Comments
 (0)