Skip to content

Commit 709381e

Browse files
committed
add: docs
1 parent cd6efa8 commit 709381e

5 files changed

Lines changed: 13 additions & 1 deletion

File tree

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ repos:
2424
entry: cargo fmt --all --check -- --color always
2525
language: system
2626
pass_filenames: false
27-
27+
2828
- id: cargocheck
2929
name: cargocheck
3030
description: Cargo checking

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Welcome to Rem Math
2+
3+
For source code [github.com](https://github.com/WrldEngine/rem_math?tab=readme-ov-file).
4+
5+
## About project
6+
7+
Rem Math - python math-bounded library written in Rust

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
site_name: Rem Math Docs
2+
theme: readthedocs

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ module-name = "rem_math._rem_math"
2222
pytest-benchmark = "^5.1.0"
2323
numpy = "^2.3.1"
2424
maturin = "^1.9.0"
25+
mkdocs = "^1.6.1"

rust-toolchain.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[toolchain]
2+
channel = "nightly"

0 commit comments

Comments
 (0)