1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
.. currentmodule:: sybil
API Reference
=============
This reference is organised into sections relating to the different :doc:`concepts <concepts>`
you're likely to encounter when using Sybil.
Sybils
------
See the :term:`Sybil` concept definition for information.
.. autoclass:: Sybil
:members:
:special-members: __add__
.. autoclass:: sybil.sybil.SybilCollection
:members:
Documents
---------
See the :term:`Document` concept definition for information.
.. autoclass:: sybil.Document
:members:
.. autoclass:: sybil.document.PythonDocument
:members:
.. autoclass:: sybil.document.PythonDocStringDocument
:members:
Regions
-------
See the :term:`Region` concept definition for information.
.. autoclass:: sybil.Region
:members:
.. autoclass:: sybil.Lexeme
:members:
:show-inheritance:
Lexing
------
See the :term:`Lexer` concept definition for information.
.. autodata:: sybil.typing.Lexer
.. autodata:: sybil.typing.LexemeMapping
.. autoclass:: sybil.parsers.abstract.lexers.BlockLexer
.. autoclass:: sybil.parsers.abstract.lexers.LexingException
Parsing
-------
See the :term:`Parser` concept definition for information.
.. autodata:: sybil.typing.Parser
.. autoclass:: sybil.parsers.abstract.codeblock.AbstractCodeBlockParser
:members:
.. autoclass:: sybil.parsers.abstract.doctest.DocTestStringParser
:members: __call__, evaluator
.. autoclass:: sybil.parsers.abstract.skip.AbstractSkipParser
:members:
.. autoclass:: sybil.parsers.abstract.clear.AbstractClearNamespaceParser
ReST Parsing and Lexing
-----------------------
See the :term:`Lexer` and :term:`Parser` concept definitions for information.
.. autoclass:: sybil.parsers.rest.lexers.DirectiveLexer
.. autoclass:: sybil.parsers.rest.lexers.DirectiveInCommentLexer
.. autoclass:: sybil.parsers.rest.CaptureParser
.. autoclass:: sybil.parsers.rest.CodeBlockParser
:inherited-members:
:exclude-members: pad
.. autoclass:: sybil.parsers.rest.PythonCodeBlockParser
.. autoclass:: sybil.parsers.rest.DocTestParser
.. autoclass:: sybil.parsers.rest.DocTestDirectiveParser
.. autoclass:: sybil.parsers.rest.SkipParser
.. autoclass:: sybil.parsers.rest.ClearNamespaceParser
Markdown Parsing and Lexing
---------------------------
See the :term:`Lexer` and :term:`Parser` concept definitions for information.
.. autoclass:: sybil.parsers.markdown.lexers.RawFencedCodeBlockLexer
.. autoclass:: sybil.parsers.markdown.lexers.FencedCodeBlockLexer
.. autoclass:: sybil.parsers.markdown.lexers.DirectiveInHTMLCommentLexer
.. autoclass:: sybil.parsers.markdown.CodeBlockParser
:inherited-members:
.. autoclass:: sybil.parsers.markdown.PythonCodeBlockParser
.. autoclass:: sybil.parsers.markdown.SkipParser
.. autoclass:: sybil.parsers.markdown.ClearNamespaceParser
MyST Parsing and Lexing
-----------------------
See the :term:`Lexer` and :term:`Parser` concept definitions for information.
.. autoclass:: sybil.parsers.myst.lexers.DirectiveLexer
.. autoclass:: sybil.parsers.myst.lexers.DirectiveInPercentCommentLexer
.. autoclass:: sybil.parsers.myst.CodeBlockParser
:inherited-members:
.. autoclass:: sybil.parsers.myst.PythonCodeBlockParser
.. autoclass:: sybil.parsers.myst.DocTestDirectiveParser
.. autoclass:: sybil.parsers.myst.SkipParser
.. autoclass:: sybil.parsers.myst.ClearNamespaceParser
Evaluation
----------
See the :term:`Evaluator` concept definition for information.
.. automodule:: sybil
:members: Example
.. autoclass:: sybil.example.NotEvaluated
.. autoclass:: sybil.typing.Evaluator
.. autodata:: sybil.evaluators.doctest.NUMBER
:annotation:
.. autoclass:: sybil.evaluators.doctest.DocTestEvaluator
.. autoclass:: sybil.evaluators.python.PythonEvaluator
|
