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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
|
"""Code to use internally, for documentation."""
from __future__ import annotations
import contextlib
import io
from collections.abc import Sequence
from typing import Union, get_args, get_origin
from docutils import nodes
from docutils.core import Publisher
from docutils.parsers.rst import directives
from sphinx.directives import other
from sphinx.transforms.post_transforms import SphinxPostTransform
from sphinx.util import logging
from sphinx.util.docutils import SphinxDirective
from myst_parser.parsers.docutils_ import to_html5_demo
from .config.main import MdParserConfig
from .parsers.docutils_ import Parser as DocutilsParser
from .warnings_ import MystWarnings
LOGGER = logging.getLogger(__name__)
class StripUnsupportedLatex(SphinxPostTransform):
"""Remove unsupported nodes from the doctree."""
default_priority = 900
def run(self, **kwargs):
if self.app.builder.format != "latex":
return
from docutils import nodes
for node in self.document.findall():
if node.tagname == "image" and node["uri"].endswith(".svg"):
node.parent.replace(node, nodes.inline("", "Removed SVG image"))
if node.tagname == "mermaid":
node.parent.replace(node, nodes.inline("", "Removed Mermaid diagram"))
class NumberSections(SphinxPostTransform):
"""Number sections (html only)"""
default_priority = 710 # same as docutils.SectNum
formats = ("html",)
def run(self, **kwargs):
min_heading_level = 2
max_heading_level = 3
stack: list[tuple[list[int], nodes.Element]] = [([], self.document)]
while stack:
path, node = stack.pop()
if len(path) >= min_heading_level:
title = node[0]
text = (
".".join(str(i) for i in path[min_heading_level - 1 :])
+ "."
+ (" " * 2)
)
# docutils SectNum transform
title.insert(0, nodes.raw("", text, format="html"))
title["auto"] = 1
if len(path) < max_heading_level:
i = 0
for child in node.children:
if isinstance(child, nodes.section):
i += 1
stack.append((path + [i], child))
class _ConfigBase(SphinxDirective):
"""Directive to automate rendering of the configuration."""
@staticmethod
def table_header():
return [
"```````{list-table}",
":header-rows: 1",
":widths: 15 10 20",
"",
"* - Name",
" - Type",
" - Description",
]
@staticmethod
def field_default(value):
default = " ".join(f"{value!r}".splitlines())
return default
@staticmethod
def field_type(field):
ftypes: Sequence[str]
ftypes = (
get_args(field.type) if get_origin(field.type) is Union else [field.type]
)
ctype = " | ".join(str("None" if ftype is None else ftype) for ftype in ftypes)
ctype = " ".join(ctype.splitlines())
ctype = ctype.replace("typing.", "")
ctype = ctype.replace("typing_extensions.", "")
for tname in ("str", "int", "float", "bool"):
ctype = ctype.replace(f"<class '{tname}'>", tname)
return ctype
class MystConfigDirective(_ConfigBase):
option_spec = {
"sphinx": directives.flag,
"extensions": directives.flag,
"scope": lambda x: directives.choice(x, ["global", "local"]),
}
def run(self):
"""Run the directive."""
config = MdParserConfig()
text = self.table_header()
count = 0
for name, value, field in config.as_triple():
if field.metadata.get("deprecated"):
continue
# filter by sphinx options
if "sphinx" in self.options and "sphinx" in field.metadata.get("omit", []):
continue
if "extensions" in self.options:
if not field.metadata.get("extension"):
continue
else:
if field.metadata.get("extension"):
continue
if self.options.get("scope") == "local" and field.metadata.get(
"global_only"
):
continue
if self.options.get("scope") == "global":
name = f"myst_{name}"
description = " ".join(field.metadata.get("help", "").splitlines())
if field.metadata.get("extension"):
description = f"{field.metadata.get('extension')}: {description}"
default = self.field_default(value)
ctype = field.metadata.get("doc_type") or self.field_type(field)
text.extend(
[
f"* - `{name}`",
f" - `{ctype}`",
f" - {description} (default: `{default}`)",
]
)
count += 1
if not count:
return []
text.append("```````")
node = nodes.Element()
self.state.nested_parse(text, 0, node)
return node.children
class DocutilsCliHelpDirective(SphinxDirective):
"""Directive to print the docutils CLI help."""
has_content = False
required_arguments = 0
optional_arguments = 0
final_argument_whitespace = False
def run(self):
"""Run the directive."""
stream = io.StringIO()
pub = Publisher(parser=DocutilsParser())
with contextlib.redirect_stdout(stream):
try:
pub.process_command_line(
["--help"],
usage="myst-docutils-<writer> [options] [<source> [<destination>]]",
)
except SystemExit as exc:
assert not exc.code
return [nodes.literal_block("", stream.getvalue())]
class DirectiveDoc(SphinxDirective):
"""Load and document a directive."""
required_arguments = 1 # name of the directive
has_content = True
def run(self):
"""Run the directive."""
name = self.arguments[0]
# load the directive class
klass, _ = directives.directive(
name, self.state.memo.language, self.state.document
)
if klass is None:
LOGGER.warning(f"Directive {name} not found.", line=self.lineno)
return []
content = " ".join(self.content)
text = f"""\
:Name: `{name}`
:Description: {content}
:Arguments: {klass.required_arguments} required, {klass.optional_arguments} optional
:Content: {'yes' if klass.has_content else 'no'}
:Options:
"""
if klass.option_spec:
text += " name | type\n -----|------\n"
for key, func in klass.option_spec.items():
text += f" {key} | {convert_opt(name, func)}\n"
node = nodes.Element()
self.state.nested_parse(text.splitlines(), 0, node)
return node.children
def convert_opt(name, func):
"""Convert an option function to a string."""
if func is directives.flag:
return "flag"
if func is directives.unchanged:
return "text"
if func is directives.unchanged_required:
return "text"
if func is directives.class_option:
return "space-delimited list"
if func is directives.uri:
return "URI"
if func is directives.path:
return "path"
if func is int:
return "integer"
if func is directives.positive_int:
return "integer (positive)"
if func is directives.nonnegative_int:
return "integer (non-negative)"
if func is directives.positive_int_list:
return "space/comma-delimited list of integers (positive)"
if func is directives.percentage:
return "percentage"
if func is directives.length_or_unitless:
return "length or unitless"
if func is directives.length_or_percentage_or_unitless:
return "length, percentage or unitless"
if func is other.int_or_nothing:
return "integer"
return ""
class MystWarningsDirective(SphinxDirective):
"""Directive to print all known warnings."""
has_content = False
required_arguments = 0
optional_arguments = 0
final_argument_whitespace = False
def run(self):
"""Run the directive."""
from sphinx.pycode import ModuleAnalyzer
analyzer = ModuleAnalyzer.for_module(MystWarnings.__module__)
qname = MystWarnings.__qualname__
analyzer.analyze()
warning_names = [
(e.value, analyzer.attr_docs[(qname, e.name)]) for e in MystWarnings
]
text = [f"- `myst.{name}`: {' '.join(doc)}" for name, doc in warning_names]
node = nodes.Element()
self.state.nested_parse(text, 0, node)
return node.children
class MystExampleDirective(SphinxDirective):
"""Directive to create an example, showing the source and output."""
has_content = True
option_spec = {
"alt-output": directives.unchanged,
"highlight": directives.unchanged,
# "html": directives.flag,
}
def run(self):
"""Run the directive."""
content_str = "\n".join(self.content)
output_str = self.options.get("alt-output", content_str)
highlight = self.options.get("highlight", "myst")
backticks = "```"
while backticks in content_str:
backticks += "`"
content = f"""
{backticks}``{{div}} myst-example
{backticks}`{{div}} myst-example-source
{backticks}{highlight}
{content_str}
{backticks}
{backticks}`
{backticks}`{{div}} myst-example-render
{output_str}
{backticks}`
{backticks}``
"""
node_ = nodes.Element()
self.state.nested_parse(content.splitlines(), self.content_offset, node_)
return node_.children
class MystAdmonitionDirective(SphinxDirective):
"""Directive to show a set of admonitions, in a tab set."""
required_arguments = 1
final_argument_whitespace = True
def run(self):
"""Run the directive."""
types = [t.strip() for t in self.arguments[0].split(",")]
content = "::::{tab-set}"
for type_ in types:
content += f"""
:::{{tab-item}} {type_}
```{{{type_}}}
This is a {type_}
```
:::
"""
content += "::::"
node_ = nodes.Element()
self.state.nested_parse(content.splitlines(), self.content_offset, node_)
return node_.children
class MystToHTMLDirective(SphinxDirective):
"""Directive to convert MyST to HTML."""
has_content = True
optional_arguments = 1
final_argument_whitespace = True
option_spec = {
"extensions": directives.unchanged,
}
def run(self):
"""Run the directive."""
content_str = "\n".join(self.content)
kwargs = {}
cli_opt = ""
if "extensions" in self.options:
ext = self.options["extensions"].split(",")
kwargs["myst_enable_extensions"] = ext
cli_opt += f"--myst-enable-extensions={self.options['extensions']}"
html = to_html5_demo(content_str, **kwargs)
content = f"""\
::::myst-example
```bash
myst-docutils-demo example.md {cli_opt}
```
```myst
{content_str}
```
```html
{html}
```
::::
"""
node_ = nodes.Element()
self.state.nested_parse(content.splitlines(), self.content_offset, node_)
return node_.children
### MyST Lexer ###
# TODO when some more work and testing, this should be made available publicly
from pygments import token # noqa: E402
from pygments.lexer import bygroups, inherit, this, using # noqa: E402
from pygments.lexers.markup import MarkdownLexer # noqa: E402
class MystLexer(MarkdownLexer):
"""A custom lexer for MyST Markdown."""
name = "MyST"
aliases = ["myst"]
filenames = ["*.myst"]
mimetypes = ["text/x-myst"]
tokens = {
"root": [
# (target)=
(
r"^(\()([^\n]+)(\)=)(\n)",
bygroups(
token.Punctuation, token.Name.Label, token.Punctuation, token.Text
),
),
# :::
(r"^([\:]{3,})(\n)", bygroups(token.Punctuation, token.Text)),
# :::name other
# TODO this seems to "eat" the next line
# (r"^([\:]{3,})([^\s\n]+)(\s+)([^\n]+)(\n)",
# bygroups(token.Punctuation, token.Name.Tag, token.Whitespace, token.Text,token.Text)),
# :::name
(
r"^([\:]{3,})([^\n]+)(\n)",
bygroups(token.Punctuation, token.Name.Tag, token.Text),
),
# :name: value
(
r"^(\:)([^\n\:]+)(\:)([^\n]+)(\n)",
bygroups(
token.Punctuation,
token.Generic.Strong,
token.Punctuation,
using(this, state="inline"),
token.Text,
),
),
inherit,
],
"inline": [
# escape (we have to copy this from the parent class)
(r"\\.", token.Text),
# {name}
(
r"(\{)([a-zA-Z0-9+:-]+)(\})",
bygroups(token.Punctuation, token.Operator.Word, token.Punctuation),
),
# <http:example.com>
(
r"(<)(http|https|mailto|project|path|inv)(\:)([^\s>]+)(>)",
bygroups(
token.Punctuation,
token.String.Other,
token.String.Other,
token.Name.Label,
token.Punctuation,
),
),
inherit,
],
}
|