From 588ae0692789b56607aaf15658b23f069877e481 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Thu, 26 Oct 2023 02:07:43 +0800 Subject: feat: newdocs --- .cache/plugin/git-committers/page-authors.json | 2 +- docs/Core/index.md | 5 +++ docs/Help/PythonSkill.md | 0 docs/Help/TermList.md | 6 ++++ docs/Help/emoji.md | 47 ++++++++++++++++++++++++++ docs/RulePackage/intro.md | 2 +- material/overrides/main.html | 9 ----- mkdocs.yml | 29 +++++----------- src/hydrorollcore/core.py | 6 ++-- src/hydrorollcore/rule.py | 14 +++++++- src/hydrorollcore/typing.py | 2 +- 11 files changed, 87 insertions(+), 35 deletions(-) create mode 100644 docs/Help/PythonSkill.md create mode 100644 docs/Help/TermList.md create mode 100644 docs/Help/emoji.md diff --git a/.cache/plugin/git-committers/page-authors.json b/.cache/plugin/git-committers/page-authors.json index e741072a..597859e2 100644 --- a/.cache/plugin/git-committers/page-authors.json +++ b/.cache/plugin/git-committers/page-authors.json @@ -1 +1 @@ -{"cache_date": "2023-10-07", "page_authors": {"docs/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/API/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Core/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Structure/attribute.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Structure/class.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Structure/method.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Write/prepare.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Write/python.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Write/write.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/what-is-rule-package.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/what-is-standard.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/why-rule-package.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/check/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/check/ability.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/dice-count.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/dice-face.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/scenario.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/setting.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/default_dice/index.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/default_dice/dice-count.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/default_dice/dice-face.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/duration/index.md": {"last_commit_date": "2023-08-11", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/duration/campaign.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/duration/module.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/duration/sene.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/player_character/index.md": {"last_commit_date": "2023-08-11", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/DefaultDice/index.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/DefaultDice/_counts.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/DefaultDice/_sides.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/PlayerCard/index.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/blog/index.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/CLI/index.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/intro.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/attribute.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/class.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/method.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/getDeeper/Module.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/getDeeper/Package.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/getDeeper/object.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/skill/index.md": {"last_commit_date": "2023-10-07", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/skill/fstring.md": {"last_commit_date": "2023-10-07", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/blog/posts/rules-class-just-landed.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}}} \ No newline at end of file +{"cache_date": "2023-10-25", "page_authors": {"docs/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/API/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Core/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Structure/attribute.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Structure/class.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Structure/method.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Write/prepare.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Write/python.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/Write/write.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/what-is-rule-package.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/what-is-standard.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/why-rule-package.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/check/index.md": {"last_commit_date": "2023-07-31", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/check/ability.md": {"last_commit_date": "2023-10-17", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/dice-count.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/dice-face.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/scenario.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/setting.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/default_dice/index.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/default_dice/dice-count.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/default_dice/dice-face.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/duration/index.md": {"last_commit_date": "2023-08-11", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/duration/campaign.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/duration/module.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/duration/sene.md": {"last_commit_date": "2023-08-04", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/player_character/index.md": {"last_commit_date": "2023-08-11", "authors": [{"login": "baimianxiao", "name": "baimianxiao", "url": "https://github.com/baimianxiao", "avatar": "https://avatars.githubusercontent.com/u/67865300"}]}, "docs/Standard/Term/DefaultDice/index.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/DefaultDice/_counts.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/DefaultDice/_sides.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/Standard/Term/PlayerCard/index.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/blog/index.md": {"last_commit_date": "2023-09-29", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/CLI/index.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/intro.md": {"last_commit_date": "2023-10-07", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/attribute.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/class.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/method.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/getDeeper/Module.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/getDeeper/Package.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/getStart/getDeeper/object.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/skill/index.md": {"last_commit_date": "2023-10-07", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/RulePackage/skill/fstring.md": {"last_commit_date": "2023-10-07", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}, "docs/blog/posts/rules-class-just-landed.md": {"last_commit_date": "2023-10-06", "authors": [{"login": "HsiangNianian", "name": "HsiangNianian", "url": "https://github.com/HsiangNianian", "avatar": "https://avatars.githubusercontent.com/u/44714368"}]}}} \ No newline at end of file diff --git a/docs/Core/index.md b/docs/Core/index.md index aff4930b..6142664c 100644 --- a/docs/Core/index.md +++ b/docs/Core/index.md @@ -1,3 +1,8 @@ +--- +hide: + - navigation +--- +

HydroRollCore'水系核心

diff --git a/docs/Help/PythonSkill.md b/docs/Help/PythonSkill.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/Help/TermList.md b/docs/Help/TermList.md new file mode 100644 index 00000000..3fa25f9f --- /dev/null +++ b/docs/Help/TermList.md @@ -0,0 +1,6 @@ +--- +title: 术语表一览 +--- + +### :material-keyboard-return:`移步正式术语` + diff --git a/docs/Help/emoji.md b/docs/Help/emoji.md new file mode 100644 index 00000000..799d730d --- /dev/null +++ b/docs/Help/emoji.md @@ -0,0 +1,47 @@ +--- +title: 图标、注释说明 +--- + +### 目录树、侧边栏图标 + +这些图标将会出现在页面左侧的 `navigation` 与文章右侧的 `toc` 当中。 + +=== ":material-trash-can:`已被废弃`" + + 在 `release` 版本中 ==不推荐使用== 但是 ==仍然有效== 的功能、特性。并且在 `latest` 版本中已经完全废弃[^1]。 + + [^1]: 具体还要看下一个大版本的文档如何编写。 + +=== ":material-alert-decagram:`最近添加`" + + 在上一个 `release` 版本作为[`实验功能`]()或作为[`扩展特性`]()但是核心本体并未支持的功能、特性，于 `latest` 版本被引入。 + +=== ":material-test-tube:`实验功能`" + + 存在于当前 `dev` 版本中但是未在 `latest` 版本中加入的功能、特性。 + +=== ":material-power-plug-outline:`扩展特性`" + + 在支持 `latest` 或 `dev` 或 ~~特定~~ `release` 版本的插件扩展中存在此特性的可行性方案。 + +### 抽象概念 + +这些图标会出现在文章内容中作为抽象概念的具体表达，用于迁移记忆。 + +以下是图标应用举例: + +* **:simple-centos:[`时代`]**: [:material-tag:`1899`]() [:material-tag:`2100`]() [:material-tag:`美好年代`]() [:material-tag:`WW II`]() [:material-tag:`2011-2021`]() +* **:simple-turborepo:[`风格`]**: [:material-tag:`中世纪`]() [:material-tag:`科幻`]() [:material-tag:`悬疑`]() [:material-tag:`心理恐怖`]() [:material-tag:`秘密剧情`]() +* **:simple-yamahamotorcorporation:[`地点`]**: [:material-tag:`卢浮宫`]() [:material-tag:`凡尔赛`]() [:material-tag:`君临城`]() [:material-tag:`火星`]() [:material-tag:`冬木`]() + + +*** + +* **:simple-sensu:[`人物背景`]**: `生于银河纪元11988年，卒于银河纪元12069年。他的卒年后来被确定为基地纪元元年。他是一位年轻有为的数学家，中等个子，长相俊朗。他曾经担任川陀大学数学系主任，是第一帝国克里昂一世皇帝的御前首相，川陀大学心理史学系荣誉教授，心理史学研究计划主持人、银河百科全书执行编辑。他是心理史学创始人之一（另一位是雨果·阿玛瑞尔），同时也是基地创始人。他还被认为是第二基地第一任首席发言者，后来也成了基地的传奇英雄。` + + +### 注释说明 + +* [`重定向至正式术语`](#): 常与:material-trash-can:一起为 过期页面 重定向内容索引。 + +*[过期页面]: 就是即将或已经弃用的功能、特性页面。 \ No newline at end of file diff --git a/docs/RulePackage/intro.md b/docs/RulePackage/intro.md index 6e492e78..a44bb314 100644 --- a/docs/RulePackage/intro.md +++ b/docs/RulePackage/intro.md @@ -2,6 +2,6 @@ title: 概述 --- -!!! warning +!!! abstract 此章节涉及到真正的 Python 规范问题，因此请认真阅读并多加练习，方能写出漂亮的代码。 diff --git a/material/overrides/main.html b/material/overrides/main.html index 9310f4df..e723f098 100644 --- a/material/overrides/main.html +++ b/material/overrides/main.html @@ -11,15 +11,6 @@ 单击此处跳转到稳定版文档. {% endblock %} -{% block announce %} - For updates follow @HydroRoll-Team on - - - {% include ".icons/fontawesome/brands/github.svg" %} - - Github - -{% endblock %} {% block scripts %} {{ super() }} diff --git a/mkdocs.yml b/mkdocs.yml index 652ad6ad..518096c8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,28 +39,13 @@ theme: - navigation.instant.prefetch - navigation.instant.progress palette: - # Palette toggle for automatic mode - - media: "(prefers-color-scheme)" - toggle: - icon: material/brightness-auto - name: Switch to light mode + scheme: slate + primary: black + accent: blue - # Palette toggle for light mode - - media: "(prefers-color-scheme: light)" - scheme: default - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - # Palette toggle for dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/brightness-4 - name: Switch to system preference font: - text: Roboto - code: Roboto Mono + text: Times New + code: Times New extra: status: new: 最近添加 @@ -211,6 +196,10 @@ nav: - "CLI Reference": CLI/index.md - API 参考: - "API Reference": API/index.md + - 其他帮助: + - "术语表一览": Help/TermList.md + - "Python 技巧": Help/PythonSkill.md + - "图标、图例、注释说明": Help/emoji.md - 博客: - blog/index.md - 日志: diff --git a/src/hydrorollcore/core.py b/src/hydrorollcore/core.py index f3c83989..56ec9404 100644 --- a/src/hydrorollcore/core.py +++ b/src/hydrorollcore/core.py @@ -15,12 +15,14 @@ class Core: try: module = importlib.import_module(rule) except ImportError as e: - raise RuleLoadError(f'Failed to load rule {rule}: {e}') + raise RuleLoadError(f'Failed to load rule {rule}: {e}') from e try: rule_cls = getattr(module, rule.split('.')[-1]) if not issubclass(rule_cls, Rule): raise RuleLoadError(f"Class '{rule_cls.__name__}' is not a subclass of 'Rule'") except AttributeError as e: - raise RuleLoadError(f"Failed to get rule class from module '{rule}': {e}") + raise RuleLoadError( + f"Failed to get rule class from module '{rule}': {e}" + ) from e loaded_rules.append(rule_cls()) return loaded_rules diff --git a/src/hydrorollcore/rule.py b/src/hydrorollcore/rule.py index 6a89b68b..eb4b92cd 100644 --- a/src/hydrorollcore/rule.py +++ b/src/hydrorollcore/rule.py @@ -1,4 +1,16 @@ from abc import ABCMeta, abstractmethod +from enum import Enum + +__all__ = ["RuleLoadType", "Rule"] + + +class RuleLoadType(Enum): + """The Type Of Rules To Be Loaded""" + + DIR = "dir" + NAME = "name" + FILE = "file" + CLASS = "class" class Rule(metaclass=ABCMeta): @@ -9,7 +21,7 @@ class Rule(metaclass=ABCMeta): @classmethod def __subclasshook__(cls, other): if cls is Rule: - return hasattr(other, 'run') and callable(getattr(other, 'run')) + return hasattr(other, "run") and callable(getattr(other, "run")) return NotImplemented @abstractmethod diff --git a/src/hydrorollcore/typing.py b/src/hydrorollcore/typing.py index 4a29d3c2..ca6a7e65 100644 --- a/src/hydrorollcore/typing.py +++ b/src/hydrorollcore/typing.py @@ -1,5 +1,5 @@ from pydantic import BaseModel - +from typing import TYPE_CHECKING, TypeVar, Callable, NoReturn, Awaitable class Config(BaseModel): rule_dir: list = [] -- cgit v1.2.3-70-g09d2