Skip to content

Commit 87cf122

Browse files
author
liuxinwei
committed
更新文档
1 parent 584c358 commit 87cf122

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+13629
-17
lines changed

docs/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@
148148
}
149149

150150
# -- HTML output -------------------------------------------------
151-
152151
html_theme = "sphinx_book_theme"
153152
html_logo = "_static/logo-wide.svg"
154153
html_favicon = "_static/logo-square.svg"
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2024, Executable Book Project
3+
# This file is distributed under the same license as the MyST Parser
4+
# package.
5+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
6+
#
7+
#, fuzzy
8+
msgid ""
9+
msgstr ""
10+
"Project-Id-Version: MyST Parser 4.0.0\n"
11+
"Report-Msgid-Bugs-To: \n"
12+
"POT-Creation-Date: 2024-12-26 16:46+0800\n"
13+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
15+
"Language: zh_CN\n"
16+
"Language-Team: zh_CN <[email protected]>\n"
17+
"Plural-Forms: nplurals=1; plural=0;\n"
18+
"MIME-Version: 1.0\n"
19+
"Content-Type: text/plain; charset=utf-8\n"
20+
"Content-Transfer-Encoding: 8bit\n"
21+
"Generated-By: Babel 2.16.0\n"
22+
23+
#: ../../apidocs/index.rst:2
24+
msgid "API Reference"
25+
msgstr ""
26+
27+
#: ../../apidocs/index.rst:4
28+
msgid "This page contains auto-generated API reference documentation [#f1]_."
29+
msgstr ""
30+
31+
#: ../../apidocs/index.rst:11
32+
msgid ""
33+
"Created with `sphinx-autodoc2 <https://github.com/chrisjsewell/sphinx-"
34+
"autodoc2>`_"
35+
msgstr ""
36+
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2024, Executable Book Project
3+
# This file is distributed under the same license as the MyST Parser
4+
# package.
5+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
6+
#
7+
#, fuzzy
8+
msgid ""
9+
msgstr ""
10+
"Project-Id-Version: MyST Parser 4.0.0\n"
11+
"Report-Msgid-Bugs-To: \n"
12+
"POT-Creation-Date: 2024-12-26 16:46+0800\n"
13+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
15+
"Language: zh_CN\n"
16+
"Language-Team: zh_CN <[email protected]>\n"
17+
"Plural-Forms: nplurals=1; plural=0;\n"
18+
"MIME-Version: 1.0\n"
19+
"Content-Type: text/plain; charset=utf-8\n"
20+
"Content-Transfer-Encoding: 8bit\n"
21+
"Generated-By: Babel 2.16.0\n"
22+
23+
#: ../../apidocs/myst_parser/myst_parser._compat.rst:4
24+
msgid ":py:mod:`myst_parser._compat`"
25+
msgstr ""
26+
27+
#: ../../../myst_parser/_compat.py:2
28+
msgid "Helpers for cross compatibility across dependency versions."
29+
msgstr ""
30+
31+
#: ../../apidocs/myst_parser/myst_parser._compat.rst:12
32+
msgid "Module Contents"
33+
msgstr ""
34+
35+
#: ../../apidocs/myst_parser/myst_parser._compat.rst:15
36+
msgid "Functions"
37+
msgstr ""
38+
39+
#: ../../apidocs/myst_parser/myst_parser._compat.rst:21
40+
msgid ":py:obj:`findall <myst_parser._compat.findall>`"
41+
msgstr ""
42+
43+
#: ../../../myst_parser/_compat.py:10
44+
msgid "Iterate through"
45+
msgstr ""
46+
47+
#: ../../apidocs/myst_parser/myst_parser._compat.rst:26
48+
msgid "API"
49+
msgstr ""
50+
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2024, Executable Book Project
3+
# This file is distributed under the same license as the MyST Parser
4+
# package.
5+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
6+
#
7+
#, fuzzy
8+
msgid ""
9+
msgstr ""
10+
"Project-Id-Version: MyST Parser 4.0.0\n"
11+
"Report-Msgid-Bugs-To: \n"
12+
"POT-Creation-Date: 2024-12-26 16:46+0800\n"
13+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
15+
"Language: zh_CN\n"
16+
"Language-Team: zh_CN <[email protected]>\n"
17+
"Plural-Forms: nplurals=1; plural=0;\n"
18+
"MIME-Version: 1.0\n"
19+
"Content-Type: text/plain; charset=utf-8\n"
20+
"Content-Transfer-Encoding: 8bit\n"
21+
"Generated-By: Babel 2.16.0\n"
22+
23+
#: ../../apidocs/myst_parser/myst_parser.cli.rst:2
24+
msgid ":py:mod:`myst_parser.cli`"
25+
msgstr ""
26+
27+
#: ../../apidocs/myst_parser/myst_parser.cli.rst:10
28+
msgid "Module Contents"
29+
msgstr ""
30+
31+
#: ../../apidocs/myst_parser/myst_parser.cli.rst:13
32+
msgid "Functions"
33+
msgstr ""
34+
35+
#: ../../apidocs/myst_parser/myst_parser.cli.rst:19
36+
msgid ":py:obj:`print_anchors <myst_parser.cli.print_anchors>`"
37+
msgstr ""
38+
39+
#: ../../apidocs/myst_parser/myst_parser.cli.rst:24
40+
msgid "API"
41+
msgstr ""
42+
Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2024, Executable Book Project
3+
# This file is distributed under the same license as the MyST Parser
4+
# package.
5+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
6+
#
7+
#, fuzzy
8+
msgid ""
9+
msgstr ""
10+
"Project-Id-Version: MyST Parser 4.0.0\n"
11+
"Report-Msgid-Bugs-To: \n"
12+
"POT-Creation-Date: 2024-12-26 16:46+0800\n"
13+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
15+
"Language: zh_CN\n"
16+
"Language-Team: zh_CN <[email protected]>\n"
17+
"Plural-Forms: nplurals=1; plural=0;\n"
18+
"MIME-Version: 1.0\n"
19+
"Content-Type: text/plain; charset=utf-8\n"
20+
"Content-Transfer-Encoding: 8bit\n"
21+
"Generated-By: Babel 2.16.0\n"
22+
23+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:2
24+
msgid ":py:mod:`myst_parser.config.dc_validators`"
25+
msgstr ""
26+
27+
#: ../../../myst_parser/config/dc_validators.py:2
28+
msgid ""
29+
"Validators for dataclasses, mirroring those of https://github.com/python-"
30+
"attrs/attrs."
31+
msgstr ""
32+
33+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:10
34+
msgid "Module Contents"
35+
msgstr ""
36+
37+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:13
38+
msgid "Classes"
39+
msgstr ""
40+
41+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:19
42+
msgid ":py:obj:`ValidatorType <myst_parser.config.dc_validators.ValidatorType>`"
43+
msgstr ""
44+
45+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:23
46+
msgid "Functions"
47+
msgstr ""
48+
49+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:29
50+
msgid ":py:obj:`validate_field <myst_parser.config.dc_validators.validate_field>`"
51+
msgstr ""
52+
53+
#: ../../../myst_parser/config/dc_validators.py:12
54+
msgid ""
55+
"Validate the field of a dataclass, according to a `validator` function "
56+
"set in the field.metadata."
57+
msgstr ""
58+
59+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:32
60+
msgid ""
61+
":py:obj:`validate_fields "
62+
"<myst_parser.config.dc_validators.validate_fields>`"
63+
msgstr ""
64+
65+
#: ../../../myst_parser/config/dc_validators.py:28
66+
msgid ""
67+
"Validate the fields of a dataclass, according to `validator` functions "
68+
"set in the field metadata."
69+
msgstr ""
70+
71+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:35
72+
msgid ":py:obj:`any_ <myst_parser.config.dc_validators.any_>`"
73+
msgstr ""
74+
75+
#: ../../../myst_parser/config/dc_validators.py:47
76+
msgid "A validator that does not perform any validation."
77+
msgstr ""
78+
79+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:38
80+
msgid ":py:obj:`instance_of <myst_parser.config.dc_validators.instance_of>`"
81+
msgstr ""
82+
83+
#: ../../../myst_parser/config/dc_validators.py:53
84+
msgid ""
85+
"A validator that raises a `TypeError` if the initializer is called with a"
86+
" wrong type for this particular attribute (checks are performed using "
87+
"`isinstance` therefore it's also valid to pass a tuple of types)."
88+
msgstr ""
89+
90+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:41
91+
msgid ":py:obj:`optional <myst_parser.config.dc_validators.optional>`"
92+
msgstr ""
93+
94+
#: ../../../myst_parser/config/dc_validators.py:75
95+
msgid ""
96+
"A validator that makes an attribute optional. An optional attribute is "
97+
"one which can be set to ``None`` in addition to satisfying the "
98+
"requirements of the sub-validator."
99+
msgstr ""
100+
101+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:44
102+
msgid ":py:obj:`is_callable <myst_parser.config.dc_validators.is_callable>`"
103+
msgstr ""
104+
105+
#: ../../../myst_parser/config/dc_validators.py:91
106+
msgid ""
107+
"A validator that raises a `TypeError` if the initializer is called with a"
108+
" value for this particular attribute that is not callable."
109+
msgstr ""
110+
111+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:47
112+
msgid ":py:obj:`in_ <myst_parser.config.dc_validators.in_>`"
113+
msgstr ""
114+
115+
#: ../../../myst_parser/config/dc_validators.py:104
116+
msgid ""
117+
"A validator that raises a `ValueError` if the initializer is called with "
118+
"a value that does not belong in the options provided. The check is "
119+
"performed using ``value in options``."
120+
msgstr ""
121+
122+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:50
123+
msgid ":py:obj:`deep_iterable <myst_parser.config.dc_validators.deep_iterable>`"
124+
msgstr ""
125+
126+
#: ../../../myst_parser/config/dc_validators.py:127
127+
msgid "A validator that performs deep validation of an iterable."
128+
msgstr ""
129+
130+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:53
131+
msgid ":py:obj:`deep_mapping <myst_parser.config.dc_validators.deep_mapping>`"
132+
msgstr ""
133+
134+
#: ../../../myst_parser/config/dc_validators.py:147
135+
msgid "A validator that performs deep validation of a dictionary."
136+
msgstr ""
137+
138+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:58
139+
msgid "API"
140+
msgstr ""
141+
142+
#: ../../../myst_parser/config/dc_validators.py:15
143+
#: ../../../myst_parser/config/dc_validators.py:33
144+
msgid ""
145+
"The validator function should take as input (inst, field, value) and "
146+
"raise an exception if the value is invalid."
147+
msgstr ""
148+
149+
#: ../../../myst_parser/config/dc_validators.py:31
150+
msgid "This function should be called in the `__post_init__` of the dataclass."
151+
msgstr ""
152+
153+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst:73
154+
msgid "Bases: :py:obj:`typing.Protocol`"
155+
msgstr ""
156+
157+
#: ../../apidocs/myst_parser/myst_parser.config.dc_validators.rst
158+
msgid "参数"
159+
msgstr ""
160+
161+
#: ../../../myst_parser/config/dc_validators.py:57
162+
msgid "The type to check for."
163+
msgstr ""
164+
165+
#: ../../../myst_parser/config/dc_validators.py:108
166+
msgid "Allowed options."
167+
msgstr ""
168+
169+
#: ../../../myst_parser/config/dc_validators.py:129
170+
msgid "Validator to apply to iterable members"
171+
msgstr ""
172+
173+
#: ../../../myst_parser/config/dc_validators.py:130
174+
msgid "Validator to apply to iterable itself"
175+
msgstr ""
176+
177+
#: ../../../myst_parser/config/dc_validators.py:149
178+
msgid "Validator to apply to dictionary keys"
179+
msgstr ""
180+
181+
#: ../../../myst_parser/config/dc_validators.py:150
182+
msgid "Validator to apply to dictionary values"
183+
msgstr ""
184+
185+
#: ../../../myst_parser/config/dc_validators.py:151
186+
msgid "Validator to apply to top-level mapping attribute (optional)"
187+
msgstr ""
188+

0 commit comments

Comments
 (0)