rst2revealjs 0.1.0__py3-none-any.whl

rst2revealjs/cli.py

@@ -0,0 +1,10 @@
+"""CLI Entrypoint."""
+
+from docutils.core import publish_cmdline
+
+from .reader import RevealjsReader
+from .writer import RevealjsWriter
+
+
+def main():
+    publish_cmdline(reader=RevealjsReader(), writer=RevealjsWriter())

rst2revealjs/engine.py

@@ -0,0 +1,58 @@
+"""Revealjs.js handler."""
+
+from __future__ import annotations
+
+from dataclasses import asdict, dataclass
+
+from jinja2 import Template
+
+DEFAULT_VERSION = "5.2.1"
+
+DEFAULT_INIT_SCRIPT = """
+{% for name, url in imports|items -%}
+import {{name}} from "{{url}}";
+{% endfor %}
+
+let deck = new Reveal({{arguments}});
+deck.initialize();
+"""
+
+
+@dataclass
+class RevealjsEngine:
+    styles: list[str]
+    imports: dict[str, str]
+    arguments: str = ""
+
+    def build_stylesheet(self) -> list[str]:
+        return [f'<link rel="stylesheet" href="{url}">' for url in self.styles]
+
+    def build_script(self) -> str:
+        tmpl = Template(DEFAULT_INIT_SCRIPT)
+        return f"""
+        <script type="module">
+        {tmpl.render(**asdict(self))}
+        </script>
+        """
+
+    @classmethod
+    def from_cdn(
+        cls, version: str, theme: str = "black", code_theme: str = "monokai"
+    ) -> RevealjsEngine:
+        styles = [
+            f"https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{version}/reveal.min.css",
+            f"https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{version}/theme/{theme}.min.css",
+            f"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/{code_theme}.min.css",
+        ]
+        imports = {
+            "Reveal": f"https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{version}/reveal.esm.min.js",
+            "RevealHighlight": f"https://cdnjs.cloudflare.com/ajax/libs/reveal.js/{version}/plugin/highlight/highlight.esm.min.js",
+        }
+        arguments = """
+        {plugins: [RevealHighlight]}
+        """
+        return cls(
+            styles=styles,
+            imports=imports,
+            arguments=arguments,
+        )

rst2revealjs/nodes.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from typing import TypedDict
+
+from docutils import nodes
+
+from .engine import RevealjsEngine
+
+
+class revealjs_deck(nodes.General, nodes.Element):
+    class Attributes(TypedDict):
+        engine: RevealjsEngine
+
+    attributes: Attributes

rst2revealjs/reader.py

@@ -0,0 +1,39 @@
+from docutils.readers.standalone import Reader
+
+from . import transforms
+from .engine import DEFAULT_VERSION
+
+
+class RevealjsReader(Reader):
+    settings_spec = Reader.settings_spec + (
+        "Reveal.js Support Options",
+        None,
+        (
+            (
+                "Using version of Reveal.js (set latest by default).",
+                ["--revealjs-version"],
+                {"dest": "revealjs_version", "default": DEFAULT_VERSION},
+            ),
+            (
+                "Reveal.js theme",
+                ["--revealjs-theme"],
+                {"dest": "revealjs_theme", "default": "black"},
+            ),
+            (
+                "Highlight.js theme used in code highlighting.",
+                ["--highlightjs-theme"],
+                {"dest": "highlightjs_theme", "default": "monokai"},
+            ),
+        ),
+    )
+
+    def read(self, source, parser, settings):
+        settings.doctitle_xform = False  # To force setting
+        return super().read(source, parser, settings)
+
+    def get_transforms(self):
+        return super().get_transforms() + [
+            transforms.RevealjsSectionizeTransform,
+            transforms.RevealjsEngineTransform,
+            transforms.TitleTransform,
+        ]

rst2revealjs/transforms.py

@@ -0,0 +1,76 @@
+from docutils import nodes
+from docutils.transforms import Transform
+
+from .engine import RevealjsEngine
+from .nodes import revealjs_deck
+
+
+class RevealjsEngineTransform(Transform):
+    """docutils transform to bind Reveal.js engine object."""
+
+    default_priority = 250
+
+    def apply(self, **kwargs):
+        settings = self.document.settings
+        data = {
+            "version": settings.revealjs_version,
+            "theme": settings.revealjs_theme,
+            "code_theme": settings.highlightjs_theme,
+        }
+        engine = RevealjsEngine.from_cdn(**data)
+        node = revealjs_deck(engine=engine)
+        self.document.append(node)
+
+
+class RevealjsSectionizeTransform(Transform):
+    """docutils transform to Reveal.js style section structure."""
+
+    default_priority = 350
+
+    def apply(self, **kwargs):
+        decks = list(self.document.findall(revealjs_deck))
+        if not decks or len(decks) > 1:
+            raise ValueError("Required only one <revealjs_deck> element to apply it.")
+        deck = decks[0]
+        deck.parent.remove(deck)
+
+        def _rebuild(root: nodes.section):
+            new_root = nodes.section()
+            sub_sections = []
+            for child in list(root.findall(nodes.section, include_self=False)):
+                if child.parent == root:
+                    child["revealjs_section_level"] = 3
+                    root.remove(child)
+                    sub_sections.append(child)
+            new_root.children = [root] + sub_sections
+            return new_root
+
+        idx = self.document.first_child_matching_class(nodes.section)
+        if idx is None:
+            raise ValueError("Invalid document for revealjs")
+        sections = [self.document[idx]]
+        sections[0]["revealjs_section_level"] = 1
+        for node in self.document.children[:idx]:
+            self.document.remove(node)
+            sections[0].insert(0, node)
+        self.document.remove(sections[0])
+        for node in list(sections[0].findall(nodes.section, include_self=False)):
+            if node.parent == sections[0]:
+                node["revealjs_section_level"] = 2
+                sections[0].remove(node)
+                sections.append(node)
+        for vertical in sections:
+            deck.append(_rebuild(vertical))
+
+        self.document.children = [deck] + self.document.children
+
+
+class TitleTransform(Transform):
+    default_priority = 351
+
+    def apply(self, **kwargs):
+        for node in self.document.findall(nodes.title):
+            self.document["title"] = node.astext()
+            break
+        else:
+            raise ValueError("Title is not found.")

rst2revealjs/writer.py

@@ -0,0 +1,98 @@
+"""Writer for docutils."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from docutils import nodes
+from docutils.writers import html5_polyglot as base_writer
+
+from .nodes import revealjs_deck
+
+
+class RevealjsTranslator(base_writer.HTMLTranslator):
+    """Custom translator to render body that is Reveal.js presentation.
+
+    It requires having nested section in doctree.
+    We recommend to override settings that ``doctitle_xform`` is ``False``
+    when source is simple content.
+    """
+
+    documenttag_args = {"tagname": "main", "class": "reveal"}
+
+    def visit_section(self, node: nodes.section):
+        if "revealjs_section_level" in node:
+            self.section_level = node["revealjs_section_level"]
+        super().visit_section(node)
+
+    def visit_literal_block(self, node: nodes.Element):
+        """Begin ``literal_block`` .
+
+        Override base method to open ``pre`` and ``code`` tags simply.
+
+        :ref: https://github.com/attakei/sphinx-revealjs/blob/master/sphinx_revealjs/writers.py
+        """
+
+        def _starttag(tagname: str, suffix: str = "\n", **attributes):
+            """Build start tag to avoide override classes."""
+            text = [f"<{tagname}"]
+            for key, value in attributes.items():
+                if value is None:
+                    text.append(key.lower())
+                else:
+                    text.append(f'{key}="{value}"')
+            text[-1] += f">{suffix}"
+            return " ".join(text)
+
+        # Detect language
+        if len(node["classes"]) < 2:
+            return super().visit_literal_block(node)
+        lang = node["classes"][1]
+        # Build <pre> tag
+        attrs_pre = {}
+        if "data-id" in node:
+            attrs_pre["data-id"] = node["data-id"]
+        elif isinstance(node.parent, nodes.section) and len(node.parent["ids"]):
+            attrs_pre["data-id"] = node.parent["ids"][0]
+        self.body.append(_starttag("pre", **attrs_pre))
+        # Build <code> tag
+        attrs_code = {
+            "class": f"language-{lang}",
+            "data-trim": None,
+            "data-noescape": None,
+        }
+        if "data-line-numbers" in node:
+            attrs_code["data-line-numbers"] = node["data-line-numbers"]
+        elif "linenos" in node:
+            attrs_code["data-line-numbers"] = "data-line-numbers"
+        if "data-ln-start-from" in node:
+            attrs_code["data-ln-start-from"] = node["data-ln-start-from"]
+            if "data-line-numbers" not in attrs_code:
+                attrs_code["data-line-numbers"] = "data-line-numbers"
+        self.body.append(_starttag("code", suffix="", **attrs_code))
+        # Write code content and close tags.
+        self.body.append(node.astext())
+        self.body.append("</code></pre>\n")
+        # It doesn't walk children, because code content has already been appended.
+        raise nodes.SkipNode
+
+    def visit_revealjs_deck(self, node: revealjs_deck):
+        self.body.append(self.starttag(node, "div", CLASS="slides"))
+
+    def depart_revealjs_deck(self, node: revealjs_deck):
+        engine = node.attributes["engine"]
+        self.stylesheet = engine.build_stylesheet()
+        self.body.append("</div>")
+        self.body.append(engine.build_script())
+
+
+class RevealjsWriter(base_writer.Writer):
+    default_template = Path(__file__).parent / "template.txt"
+
+    def __init__(self):
+        super().__init__()
+        self.translator_class = RevealjsTranslator
+
+    def write(self, document, destination):
+        document.settings.initial_header_level = 0  # To force setting
+        return super().write(document, destination)

rst2revealjs-0.1.0.dist-info/METADATA

@@ -0,0 +1,73 @@
+Metadata-Version: 2.3
+Name: rst2revealjs
+Version: 0.1.0
+Summary: Add your description here
+Author: Kazuya Takei
+Author-email: Kazuya Takei <myself@attakei.net>
+Requires-Dist: docutils>=0.21.2
+Requires-Dist: jinja2>=3.1.6
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+
+============
+rst2revealjs
+============
+
+Simple converter from docutils AST to Reveal.js presentation.
+
+Overview
+========
+
+This is docutils adapter to write Reveal.js presentation by reStructuredText and other formats.
+You can write presentation by plain text using many expression of reStructuredText.
+
+Usage
+=====
+
+.. warning:: This section is included plan and it is not availabled yet.
+
+.. code:: console
+
+   pip install rst2revealjs
+
+.. code:: rst
+
+   Title
+   =====
+
+   Section 1
+   =========
+
+   Section 1-1
+   -----------
+
+.. code:: console
+
+   rst2revealjs presentation.rst
+
+You can see `presentation.html` by your browser.
+
+Features
+========
+
+This provides some features to realize overview.
+
+* Custom directives for specify behaviors about Reveal.js.
+* Writer to generate HTML file using Reveal.js presentation.
+
+Motivation
+==========
+
+This is re-implement from core features of sphinx-revealjs.
+Because I want to write Reveal.js presentation on Web front-end using Pyodide. [#]_
+
+As first goal, I will provide playground website to convert from reStructuredText to presentation using this.
+
+License
+=======
+
+Apache-2.0 license. Please see LICENSE on repository.
+
+.. rubric:: Footnotes
+
+.. [#] docutils is registered on Pyodided built-in packages, but Sphinx is not registered.

rst2revealjs-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+rst2revealjs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rst2revealjs/cli.py,sha256=HChh5TOYmf-B33Sokhv_IOP-uxl9vjUMeSyutyGYjG8,220
+rst2revealjs/engine.py,sha256=LepabBNOedOi2lMxlCTKlfQ8MRUNwhYQ0BY0GDYWcV4,1684
+rst2revealjs/nodes.py,sha256=eMacHzQc5Q6Zl_hWi9V253vd50O-nOpsplDwydFX7xc,274
+rst2revealjs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rst2revealjs/reader.py,sha256=_0SX-1eoU1CxuTJr1UfbeVN8lfOnJm-odjaDhBAF2S0,1233
+rst2revealjs/transforms.py,sha256=mZpebJvUOj3ZqVAiLcCDFYUdhDhOD1QA_nJcTkc0V5U,2629
+rst2revealjs/writer.py,sha256=VJU9px68afrXfFA8zbrReQtXeD4mL91ASNRHDP7EEbo,3625
+rst2revealjs-0.1.0.dist-info/WHEEL,sha256=eycQt0QpYmJMLKpE3X9iDk8R04v2ZF0x82ogq-zP6bQ,79
+rst2revealjs-0.1.0.dist-info/entry_points.txt,sha256=WDWR2xbO5la36gT_FFYwU9qeL-RuLxX3NNai9vxSdcA,56
+rst2revealjs-0.1.0.dist-info/METADATA,sha256=bzWZYQeeLSeB_gYRa4p1GWVCO8kge_OQJmoH3m-oFs0,1571
+rst2revealjs-0.1.0.dist-info/RECORD,,

rst2revealjs-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.24
+Root-Is-Purelib: true
+Tag: py3-none-any

rst2revealjs-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+rst2revealjs = rst2revealjs.cli:main
+