docs: Split the examples into separate files

examples/add_open_set_to_hand.py

@@ -0,0 +1,26 @@
+####################################################################
+# Add open set to hand                                             #
+####################################################################
+
+from mahjong.hand_calculating.hand import HandCalculator
+from mahjong.hand_calculating.hand_config import HandConfig, OptionalRules
+from mahjong.meld import Meld
+from mahjong.tile import TilesConverter
+
+# we had to use all 14 tiles in that array
+tiles = TilesConverter.string_to_136_array(man="22444", pin="333567", sou="444")
+win_tile = TilesConverter.string_to_136_array(sou="4")[0]
+melds = [Meld(meld_type=Meld.PON, tiles=TilesConverter.string_to_136_array(man="444"))]
+
+result = HandCalculator.estimate_hand_value(
+    tiles,
+    win_tile,
+    melds=melds,
+    config=HandConfig(options=OptionalRules(has_open_tanyao=True)),
+)
+
+print(result.han, result.fu)
+print(result.cost["main"])
+print(result.yaku)
+for fu_item in result.fu_details:
+    print(fu_item)

examples/change_the_cost_of_yaku.py

@@ -0,0 +1,22 @@
+####################################################################
+# Change the cost of yaku                                          #
+####################################################################
+
+from mahjong.hand_calculating.hand import HandCalculator
+from mahjong.hand_calculating.hand_config import HandConfig
+from mahjong.tile import TilesConverter
+
+config = HandConfig(is_renhou=True)
+# renhou as an yakuman - old style
+config.yaku.renhou.han_closed = 13
+
+tiles = TilesConverter.string_to_136_array(man="22444", pin="333567", sou="444")
+win_tile = TilesConverter.string_to_136_array(sou="4")[0]
+
+result = HandCalculator.estimate_hand_value(tiles, win_tile, config=config)
+
+print(result.han, result.fu)
+print(result.cost["main"])
+print(result.yaku)
+for fu_item in result.fu_details:
+    print(fu_item)

examples/kazoe_as_a_sanbaiman.py

@@ -0,0 +1,28 @@
+####################################################################
+# Kazoe as a sanbaiman                                             #
+####################################################################
+
+from mahjong.hand_calculating.hand import HandCalculator
+from mahjong.hand_calculating.hand_config import HandConfig, OptionalRules
+from mahjong.meld import Meld
+from mahjong.tile import TilesConverter
+
+tiles = TilesConverter.string_to_136_array(man="222244466677788")
+win_tile = TilesConverter.string_to_136_array(man="7")[0]
+melds = [Meld(Meld.KAN, TilesConverter.string_to_136_array(man="2222"), False)]
+
+dora_indicators = [
+    TilesConverter.string_to_136_array(man="1")[0],
+    TilesConverter.string_to_136_array(man="1")[0],
+    TilesConverter.string_to_136_array(man="1")[0],
+    TilesConverter.string_to_136_array(man="1")[0],
+]
+
+config = HandConfig(is_riichi=True, options=OptionalRules(kazoe_limit=HandConfig.KAZOE_SANBAIMAN))
+result = HandCalculator.estimate_hand_value(tiles, win_tile, melds, dora_indicators, config)
+
+print(result.han, result.fu)
+print(result.cost["main"])
+print(result.yaku)
+for fu_item in result.fu_details:
+    print(fu_item)

examples/shanten_calculation.py

@@ -0,0 +1,11 @@
+####################################################################
+# Shanten calculation                                              #
+####################################################################
+
+from mahjong.shanten import Shanten
+from mahjong.tile import TilesConverter
+
+tiles = TilesConverter.string_to_34_array(man="13569", pin="123459", sou="443")
+result = Shanten.calculate_shanten(tiles)
+
+print(result)

examples/tanyao_hand_by_ron.py

@@ -0,0 +1,18 @@
+####################################################################
+# Tanyao hand by ron                                               #
+####################################################################
+
+from mahjong.hand_calculating.hand import HandCalculator
+from mahjong.tile import TilesConverter
+
+# we had to use all 14 tiles in that array
+tiles = TilesConverter.string_to_136_array(man="22444", pin="333567", sou="444")
+win_tile = TilesConverter.string_to_136_array(sou="4")[0]
+
+result = HandCalculator.estimate_hand_value(tiles, win_tile)
+
+print(result.han, result.fu)
+print(result.cost["main"])
+print(result.yaku)
+for fu_item in result.fu_details:
+    print(fu_item)

examples/tanyao_hand_by_tsumo.py

@@ -0,0 +1,19 @@
+####################################################################
+# Tanyao hand by tsumo                                             #
+####################################################################
+
+from mahjong.hand_calculating.hand import HandCalculator
+from mahjong.hand_calculating.hand_config import HandConfig
+from mahjong.tile import TilesConverter
+
+# we had to use all 14 tiles in that array
+tiles = TilesConverter.string_to_136_array(man="22444", pin="333567", sou="444")
+win_tile = TilesConverter.string_to_136_array(sou="4")[0]
+
+result = HandCalculator.estimate_hand_value(tiles, win_tile, config=HandConfig(is_tsumo=True))
+
+print(result.han, result.fu)
+print(result.cost["main"])
+print(result.yaku)
+for fu_item in result.fu_details:
+    print(fu_item)

pyproject.toml

@@ -90,7 +90,7 @@ max-doc-length = 120
 ignore-overlong-task-comments = true
 
 [tool.ruff.lint.extend-per-file-ignores]
-"./doc/*" = [
+"./examples/*" = [
     "T201",    # print
     "INP001",  # implicit-namespace-package
 ]