sphinx-revealjs-ext-codeblock 0.1.0__tar.gz

sphinx_revealjs_ext_codeblock-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish Python Package
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - uses: pypa/hatch@install
+      - name: Build package
+        run: |
+          hatch build
+          pipx run twine check dist/*
+      - uses: pypa/gh-action-pypi-publish@release/v1

sphinx_revealjs_ext_codeblock-0.1.0/.github/workflows/testing.yml

@@ -0,0 +1,12 @@
+name: Run tests
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pypa/hatch@install
+      - run: hatch test --randomize --all -vv

sphinx_revealjs_ext_codeblock-0.1.0/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

sphinx_revealjs_ext_codeblock-0.1.0/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.

sphinx_revealjs_ext_codeblock-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,82 @@
+# 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/pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sphinx-revealjs-ext-codeblock"
+dynamic = ["version"]
+description = 'Extend code-block directive for sphinx-revealjs builder'
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+  { name = "ftnext", email = "takuyafjp+develop@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "License :: OSI Approved :: MIT License",
+  "Intended Audience :: Developers",
+  "Framework :: Sphinx",
+  "Framework :: Sphinx :: Extension",
+  "Topic :: Documentation",
+  "Topic :: Documentation :: Sphinx",
+  "Topic :: Software Development :: Documentation",
+  "Topic :: Text Processing :: Markup :: HTML",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dependencies = ["sphinx-revealjs", "sphinxcontrib-extdevhelper-kasane"]
+
+[project.urls]
+Documentation = "https://github.com/ftnext/sphinx-revealjs-ext-codeblock#readme"
+Issues = "https://github.com/ftnext/sphinx-revealjs-ext-codeblock/issues"
+Source = "https://github.com/ftnext/sphinx-revealjs-ext-codeblock"
+
+[tool.hatch.version]
+path = "src/sphinx_revealjs_ext_codeblock/__about__.py"
+
+[tool.hatch.envs.hatch-test]
+extra-dependencies = ["beautifulsoup4"]
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/sphinx_revealjs_ext_codeblock tests}"
+
+[tool.coverage.run]
+source_pkgs = ["sphinx_revealjs_ext_codeblock", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/sphinx_revealjs_ext_codeblock/__about__.py",
+]
+
+[tool.coverage.paths]
+sphinx_revealjs_ext_codeblock = ["src/sphinx_revealjs_ext_codeblock", "*/sphinx-revealjs-ext-codeblock/src/sphinx_revealjs_ext_codeblock"]
+tests = ["tests", "*/sphinx-revealjs-ext-codeblock/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

sphinx_revealjs_ext_codeblock-0.1.0/src/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-0.1.0/src/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/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2025-present ftnext <takuyafjp+develop@gmail.com>
+#
+# SPDX-License-Identifier: MIT

sphinx_revealjs_ext_codeblock-0.1.0/tests/conftest.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+
+import pytest
+
+pytest_plugins = ("sphinx.testing.fixtures",)
+collect_ignore = ["roots"]
+
+
+@pytest.fixture(scope="session")
+def rootdir() -> Path:
+    return Path(__file__).parent / "roots"

sphinx_revealjs_ext_codeblock-0.1.0/tests/roots/test-default/conf.py

@@ -0,0 +1,11 @@
+extensions = ["sphinx_revealjs", "sphinx_revealjs_ext_codeblock"]
+
+revealjs_script_plugins = [
+    {
+        "name": "RevealHighlight",
+        "src": "revealjs/plugin/highlight/highlight.js",
+    },
+]
+revealjs_css_files = [
+    "revealjs/plugin/highlight/zenburn.css",
+]

sphinx_revealjs_ext_codeblock-0.1.0/tests/roots/test-default/index.rst

@@ -0,0 +1,10 @@
+Slide
+=====
+
+Code block
+----------
+
+.. code-block:: python
+
+    while True:
+        print("Hello world!")

sphinx_revealjs_ext_codeblock-0.1.0/tests/roots/test-emphasize-lines/conf.py

@@ -0,0 +1,11 @@
+extensions = ["sphinx_revealjs", "sphinx_revealjs_ext_codeblock"]
+
+revealjs_script_plugins = [
+    {
+        "name": "RevealHighlight",
+        "src": "revealjs/plugin/highlight/highlight.js",
+    },
+]
+revealjs_css_files = [
+    "revealjs/plugin/highlight/zenburn.css",
+]

sphinx_revealjs_ext_codeblock-0.1.0/tests/roots/test-emphasize-lines/index.rst

@@ -0,0 +1,11 @@
+Slide
+=====
+
+Code block
+----------
+
+.. code-block:: python
+    :emphasize-lines: 2
+
+    while True:
+        print("Hello world!")

sphinx_revealjs_ext_codeblock-0.1.0/tests/roots/test-line-numbers/conf.py

@@ -0,0 +1,11 @@
+extensions = ["sphinx_revealjs", "sphinx_revealjs_ext_codeblock"]
+
+revealjs_script_plugins = [
+    {
+        "name": "RevealHighlight",
+        "src": "revealjs/plugin/highlight/highlight.js",
+    },
+]
+revealjs_css_files = [
+    "revealjs/plugin/highlight/zenburn.css",
+]

sphinx_revealjs_ext_codeblock-0.1.0/tests/roots/test-line-numbers/index.rst

@@ -0,0 +1,11 @@
+Slide
+=====
+
+Code block
+----------
+
+.. code-block:: python
+    :linenos:
+
+    while True:
+        print("Hello world!")

sphinx_revealjs_ext_codeblock-0.1.0/tests/test_sphinx_revealjs_ext_codeblock.py

@@ -0,0 +1,45 @@
+import pytest
+from bs4 import BeautifulSoup
+
+
+@pytest.mark.sphinx("revealjs", testroot="default")
+def test_normal_code_block(app):
+    app.build()
+
+    slide_contents = (app.outdir / "index.html").read_text()
+    soup = BeautifulSoup(slide_contents, "html.parser")
+    pre_tags = soup.find_all("pre")
+    assert len(pre_tags) == 1
+    pre_tag = pre_tags[0]
+    pre_attrs = pre_tag.attrs
+    assert pre_attrs["data-id"] == "code-block"
+    code_tag = pre_tag.code
+    code_attrs = code_tag.attrs
+    assert "data-trim" in code_attrs
+    assert "data-noescape" in code_attrs
+    assert "python" in code_attrs["class"]
+    assert "data-line-numbers" not in code_attrs
+
+
+@pytest.mark.sphinx("revealjs", testroot="line-numbers")
+def test_code_block_linenos(app):
+    app.build()
+
+    slide_contents = (app.outdir / "index.html").read_text()
+    soup = BeautifulSoup(slide_contents, "html.parser")
+    pre_tags = soup.find_all("pre")
+    code_tag = pre_tags[0].code
+    code_attrs = code_tag.attrs
+    assert code_attrs["data-line-numbers"] == ""
+
+
+@pytest.mark.sphinx("revealjs", testroot="emphasize-lines")
+def test_code_block_emphasize_lines(app):
+    app.build()
+
+    slide_contents = (app.outdir / "index.html").read_text()
+    soup = BeautifulSoup(slide_contents, "html.parser")
+    pre_tags = soup.find_all("pre")
+    code_tag = pre_tags[0].code
+    code_attrs = code_tag.attrs
+    assert code_attrs["data-line-numbers"] == "2"