Skip to content

Improve generation of meta nodes #1080

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AA-Turner wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve generation of meta nodes #1080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions myst_parser/mdit_to_docutils/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
from docutils.parsers.rst.directives.misc import Include
from docutils.parsers.rst.languages import get_language as get_language_rst
from docutils.statemachine import StringList
from docutils.transforms.components import Filter
from docutils.utils import Reporter, SystemMessage, new_document
from docutils.utils.code_analyzer import Lexer, LexerError, NumberLines
from markdown_it import MarkdownIt
Expand Down Expand Up @@ -1883,7 +1882,7 @@ def render_substitution(self, token: SyntaxTreeNode, inline: bool) -> None:

def html_meta_to_nodes(
data: dict[str, Any], document: nodes.document, line: int, reporter: Reporter
) -> list[nodes.pending | nodes.system_message]:
) -> list[nodes.meta | nodes.system_message]:
"""Replicate the `meta` directive,
by converting a dictionary to a list of pending meta nodes

Expand Down Expand Up @@ -1917,14 +1916,8 @@ def html_meta_to_nodes(
except ValueError as error:
msg = reporter.error(f'Error parsing meta tag attribute "{key}": {error}.')
output.append(msg)
continue

pending = nodes.pending(
Filter,
{"component": "writer", "format": "html", "nodes": [meta_node]},
)
document.note_pending(pending)
output.append(pending)
else:
output.append(meta_node)

return output

Expand Down
36 changes: 4 additions & 32 deletions tests/test_renderers/fixtures/docutil_syntax_elements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,38 +672,10 @@ myst:
---
.
<document source="notset">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="Sphinx, documentation, builder" name="keywords">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="An amusing story" lang="en" name="description">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="Un histoire amusant" lang="fr" name="description">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<meta content="Sphinx, documentation, builder" name="keywords">
<meta content="An amusing story" lang="en" name="description">
<meta content="Un histoire amusant" lang="fr" name="description">
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
.

Full Test:
Expand Down
36 changes: 4 additions & 32 deletions tests/test_renderers/fixtures/sphinx_syntax_elements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -674,38 +674,10 @@ myst:
---
.
<document source="<src>/index.md">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="Sphinx, documentation, builder" name="keywords">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="An amusing story" lang="en" name="description">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="Un histoire amusant" lang="fr" name="description">
<pending>
.. internal attributes:
.transform: docutils.transforms.components.Filter
.details:
component: 'writer'
format: 'html'
nodes:
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<meta content="Sphinx, documentation, builder" name="keywords">
<meta content="An amusing story" lang="en" name="description">
<meta content="Un histoire amusant" lang="fr" name="description">
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
.

Full Test:
Expand Down