Skip to content

Commit 88ace64

Browse files
committed
add links to documentation
1 parent 71143ab commit 88ace64

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@
22

33
![Tests](https://github.com/Deric-W/lambda_calculus/actions/workflows/Tests.yaml/badge.svg)
44
[![codecov](https://codecov.io/gh/Deric-W/lambda_calculus/branch/main/graph/badge.svg?token=SU3982mC17)](https://codecov.io/gh/Deric-W/lambda_calculus)
5+
[![Documentation Status](https://readthedocs.org/projects/lambda-calculus/badge/?version=stable)](https://lambda-calculus.readthedocs.io/en/stable/?badge=stable)
56

6-
The `lambda_calculus` package contains classes which implement basic operations of the lambda calculus.
7+
The [`lambda_calculus`](https://pypi.org/project/lambda-calculus/) package contains classes which implement basic operations of the lambda calculus.
78

89
To use it, simply import the classes `Variable`, `Abstraction` and `Application` from this package
910
and nest them to create more complex lambda terms.
1011

1112
You can also use the `visitors` subpackage to define your own operations on terms or
1213
use predefined ones from the `terms` subpackage.
1314

15+
More information is available on [Read the Docs](https://lambda-calculus.readthedocs.io/).
16+
1417
## Notice
1518

1619
This package is intended to be used for educational purposes and is not optimized for speed.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ email = "[email protected]"
2424

2525
[project.urls]
2626
Repository = "https://github.com/Deric-W/lambda_calculus"
27+
Documentation = "http://lambda-calculus.readthedocs.io/"
2728
Bugtracker = "https://github.com/Deric-W/lambda_calculus/issues"
2829

2930
[build-system]

0 commit comments

Comments
 (0)