sphinx-revealjs-ext-codeblock 0.1.0__py3-none-any.whl

sphinx_revealjs_ext_codeblock/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2025-present ftnext <takuyafjp+develop@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.1.0"

sphinx_revealjs_ext_codeblock/__init__.py

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: 2025-present ftnext <takuyafjp+develop@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+from docutils.nodes import literal_block, section
+from sphinx.util.typing import ExtensionMetadata
+from sphinxcontrib.kasane import TranslatorSetUp
+from sphinxcontrib.kasane.conditions import BuilderNameCondition
+from sphinxcontrib.kasane.inheritance import MixinDynamicInheritance
+
+from sphinx_revealjs_ext_codeblock.__about__ import __version__
+
+
+class ExtendedLiteralRevealjsSlideTranslatorMixin:
+    def visit_literal_block(self, node: literal_block):
+        lang = node["language"]
+        # add section id as data-id if it is exists
+        if "data-id" in node:
+            self.body.append(f"<pre data-id=\"{node['data-id']}\">")
+        elif isinstance(node.parent, section) and len(node.parent["ids"]):
+            self.body.append(f"<pre data-id=\"{node.parent['ids'][0]}\">")
+        else:
+            self.body.append("<pre>")
+        self.body.append(f'<code data-trim data-noescape class="{lang}"')
+        # use the emphasize-lines directive to create line for line animations
+        if "data-line-numbers" in node:
+            self.body.append(f" data-line-numbers=\"{node['data-line-numbers']}\"")
+        # Tweak https://github.com/attakei/sphinx-revealjs/compare/master...ftnext:sphinx-revealjs:code-block-emphasize-lines
+        elif highlight_args := node.get("highlight_args"):
+            if "hl_lines" in highlight_args:
+                highlight_lines = ",".join(str(num) for num in highlight_args["hl_lines"])
+                self.body.append(f' data-line-numbers="{highlight_lines}"')
+        # Tweak End
+        elif node["linenos"]:
+            self.body.append(" data-line-numbers")
+        if "data-ln-start-from" in node:
+            self.body.append(f" data-ln-start-from=\"{node['data-ln-start-from']}\"")
+            if "data-line-numbers" not in node:
+                self.body.append(" data-line-numbers")
+        self.body.append(">")
+
+
+def setup(app) -> ExtensionMetadata:
+    condition = BuilderNameCondition("revealjs")
+    inheritance = MixinDynamicInheritance(
+        ExtendedLiteralRevealjsSlideTranslatorMixin,
+        "ExtendedLiteralRevealjsSlideTranslator",
+    )
+    app.connect("builder-inited", TranslatorSetUp(inheritance, condition))
+
+    return ExtensionMetadata(version=__version__)

sphinx_revealjs_ext_codeblock-0.1.0.dist-info/METADATA

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: sphinx-revealjs-ext-codeblock
+Version: 0.1.0
+Summary: Extend code-block directive for sphinx-revealjs builder
+Project-URL: Documentation, https://github.com/ftnext/sphinx-revealjs-ext-codeblock#readme
+Project-URL: Issues, https://github.com/ftnext/sphinx-revealjs-ext-codeblock/issues
+Project-URL: Source, https://github.com/ftnext/sphinx-revealjs-ext-codeblock
+Author-email: ftnext <takuyafjp+develop@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Requires-Python: >=3.9
+Requires-Dist: sphinx-revealjs
+Requires-Dist: sphinxcontrib-extdevhelper-kasane
+Description-Content-Type: text/markdown
+
+# sphinx-revealjs-ext-codeblock
+
+[![PyPI - Version](https://img.shields.io/pypi/v/sphinx-revealjs-ext-codeblock.svg)](https://pypi.org/project/sphinx-revealjs-ext-codeblock)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-revealjs-ext-codeblock.svg)](https://pypi.org/project/sphinx-revealjs-ext-codeblock)
+
+Extend `code-block` directive for Sphinx `revealjs` builder.
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Installation
+
+```console
+pip install sphinx-revealjs-ext-codeblock
+```
+
+## Usage
+
+conf.py
+
+```python
+extensions = [
+    "sphinx_revealjs",
+    "sphinx_revealjs_ext_codeblock",
+]
+```
+
+Specify `revealjs_script_plugins` & `revealjs_css_files`.
+
+* https://sphinx-revealjs.readthedocs.io/en/stable/configurations/#confval-revealjs_script_plugins
+* https://sphinx-revealjs.readthedocs.io/en/stable/configurations/#confval-revealjs_css_files
+
+### Line Numbers
+
+```rst
+.. code-block:: python
+    :linenos:
+
+    while True:
+        print("Hello world!")
+```
+
+```html
+<pre>
+  <code class="python" data-line-numbers>
+while True:
+    print(&quot;Hello world!&quot;)
+  </code>
+</pre>
+```
+
+See https://revealjs.com/code/#line-numbers-%26-highlights
+
+### Highlights
+
+```rst
+.. code-block:: python
+    :emphasize-lines: 2
+
+    while True:
+        print("Hello world!")
+```
+
+```html
+<pre>
+  <code class="python" data-line-numbers="2">
+while True:
+    print(&quot;Hello world!&quot;)
+  </code>
+</pre>
+```
+
+See https://revealjs.com/code/#line-numbers-%26-highlights
+
+## License
+
+`sphinx-revealjs-ext-codeblock` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

sphinx_revealjs_ext_codeblock-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+sphinx_revealjs_ext_codeblock/__about__.py,sha256=FAMBQ59-ourcMTsagzlZFwAmV4c4oBseBLGJPa-HYaI,131
+sphinx_revealjs_ext_codeblock/__init__.py,sha256=1ZMdZXEIiFVAPSzGz1ewnPDxRtCDESLfH4SsjpghI40,2351
+sphinx_revealjs_ext_codeblock-0.1.0.dist-info/METADATA,sha256=1sJtsjqY6SJ2Y-aNQI_p1tLC35l1cSNcqWF2IhRg84M,3121
+sphinx_revealjs_ext_codeblock-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sphinx_revealjs_ext_codeblock-0.1.0.dist-info/licenses/LICENSE,sha256=KkcnYlzXOSv9r5vZOx9y_VY3PCcQxLhX8zy83xtkaOs,1063
+sphinx_revealjs_ext_codeblock-0.1.0.dist-info/RECORD,,

sphinx_revealjs_ext_codeblock-0.1.0.dist-info/WHEEL

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

sphinx_revealjs_ext_codeblock-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 nikkie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.