sphinxnotes.render 1.0a42__py3-none-any.whl

sphinxnotes/render/utils/freestyle.py

@@ -0,0 +1,93 @@
+import re
+from typing import Callable, Any
+
+from docutils import nodes
+from docutils.utils import assemble_option_dict
+from docutils.parsers.rst import directives
+from docutils.parsers.rst.states import Body
+
+from sphinx.util import logging
+from sphinx.util.docutils import SphinxDirective
+
+from ..utils import parse_text_to_nodes
+
+logger = logging.getLogger(__name__)
+
+
+class FreeStyleOptionSpec(dict):
+    """
+    An option_spec that accepts any key and always return the same conversion
+    function.
+    """
+
+    def __init__(self, conv: Callable[[str], Any] = directives.unchanged):
+        self.conv = conv
+
+    def __getitem__(self, _):
+        return self.conv
+
+
+class FreeStyleDirective(SphinxDirective):
+    """
+    TODO: https://docutils.sourceforge.io/docs/ref/rst/directives.html#role
+    """
+
+    final_argument_whitespace = True
+    option_spec = FreeStyleOptionSpec()
+
+    _arguments: list[str]
+    _options: dict[str, str]
+
+    @property
+    def arguments(self) -> list[str]:
+        return self._arguments
+
+    @arguments.setter
+    def arguments(self, value: list[str]) -> None:  # type: ignore
+        if len(value) == 0:
+            self._arguments, self._options = [], {}
+            return
+
+        last_arg_and_opts = value.pop()
+        self._arguments = value
+        last_arg, self._options = self._parse_options(last_arg_and_opts)
+        self._arguments.append(last_arg)
+
+    @property
+    def options(self) -> dict[str, str]:
+        return self._options
+
+    @options.setter
+    def options(self, _: dict[str, str]) -> None: ...  # type: ignore
+
+    def _parse_options(self, args_and_opts: str) -> tuple[str, dict[str, str]]:
+        """Returns (last argument, parsed options)."""
+        arg_block = args_and_opts.split('\n')
+        opt_block = None
+
+        # Extract options from arguments.
+        # See also :meth:`docutils.parsers.rst.Body::parse_directive_options`.
+        for i, line in enumerate(arg_block):
+            if re.match(Body.patterns['field_marker'], line):
+                opt_block = arg_block[i:]
+                arg_block = arg_block[:i]
+                break
+
+        # Parse options raw text to dict[str, str].
+        options = {}
+        if opt_block:
+            option_list = self._parse_field_list('\n'.join(opt_block))
+            options = assemble_option_dict(option_list, self.option_spec)
+
+        return '\n'.join(arg_block), options
+
+    @staticmethod
+    def _parse_field_list(text: str) -> list[tuple[str, str]]:
+        field_lists = []
+        for node in parse_text_to_nodes(text):
+            for field_list in node.findall(nodes.field_list):
+                for field in field_list:
+                    name = field.children[0].astext()
+                    value = field.children[1].astext()
+                    field_lists.append((name, value))
+        return field_lists

sphinxnotes_render-1.0a42.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: sphinxnotes.render
+Version: 1.0a42
+Summary: A framework to define, constrain, and render data in Sphinx documentation
+Author: Shengyu Zhang
+Maintainer: Shengyu Zhang
+License-Expression: BSD-3-Clause
+Project-URL: homepage, https://sphinx.silverrainz.me/render
+Project-URL: documentation, https://sphinx.silverrainz.me/render
+Project-URL: repository, https://github.com/sphinx-notes/data
+Project-URL: changelog, https://sphinx.silverrainz.me/render/changelog.html
+Project-URL: tracker, https://github.com/sphinx-notes/data/issues
+Keywords: sphinx,extension,documentation,sphinxnotes
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Plugins
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: Sphinx>=7.0
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: cruft; extra == "dev"
+Requires-Dist: ruff>=0.11.10; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: docs
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinxcontrib-gtagjs; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
+Requires-Dist: sphinxext-opengraph; extra == "docs"
+Requires-Dist: sphinx-last-updated-by-git; extra == "docs"
+Requires-Dist: sphinxnotes-project; extra == "docs"
+Requires-Dist: sphinxnotes-comboroles; extra == "docs"
+Dynamic: license-file
+
+.. This file is generated from sphinx-notes/cookiecutter.
+   You need to consider modifying the TEMPLATE or modifying THIS FILE.
+
+==================
+sphinxnotes.render
+==================
+
+.. |docs| image:: https://img.shields.io/github/deployments/sphinx-notes/render/github-pages
+   :target: https://sphinx.silverrainz.me/render
+   :alt: Documentation Status
+.. |license| image:: https://img.shields.io/github/license/sphinx-notes/render
+   :target: https://github.com/sphinx-notes/data/blob/master/LICENSE
+   :alt: Open Source License
+.. |pypi| image:: https://img.shields.io/pypi/v/sphinxnotes.render.svg
+   :target: https://pypi.python.org/pypi/sphinxnotes.render
+   :alt: PyPI Package
+.. |download| image:: https://img.shields.io/pypi/dm/sphinxnotes.render
+   :target: https://pypistats.org/packages/sphinxnotes.render
+   :alt: PyPI Package Downloads
+
+|docs| |license| |pypi| |download|
+
+A framework to define, constrain, and render data in Sphinx documentation.
+
+.. INTRODUCTION START 
+   (MUST written in standard reStructuredText, without Sphinx stuff)
+
+.. INTRODUCTION END
+
+Please refer to Documentation_ for more details.
+
+.. _Documentation: https://sphinx.silverrainz.me/render

sphinxnotes_render-1.0a42.dist-info/RECORD

@@ -0,0 +1,20 @@
+sphinxnotes/render/__init__.py,sha256=7jEnIimijWH1PXHl1jOOEYvHK23k8FQq4mQzQyuihx8,1808
+sphinxnotes/render/ctx.py,sha256=M86AeXz07ywOWQ5Rf4exCl9xZ56pe7DcdY6UKCVAtwI,2096
+sphinxnotes/render/ctxnodes.py,sha256=1k1rx3B8d2h_muXoiVm0IAf_GMMhluxUC28II5MSpao,8713
+sphinxnotes/render/data.py,sha256=cun57jHVdyDLQHHBeUiTPYTG2RNxwbNgVlUyLCQzlJM,16363
+sphinxnotes/render/extractx.py,sha256=1pamKe0mkgIxIXtIHMlLN8vvQuiX5-4lTWtjnHIFs1o,5509
+sphinxnotes/render/markup.py,sha256=Rpdx1uIBg9haWW8iWJRJPlZKX2WGhkjB9s3_Ino3fIE,4318
+sphinxnotes/render/meta.py,sha256=_NhgwS4FtVHuk5QnVYZrZ3xZHI_svV35bVlzXO8rNmo,996
+sphinxnotes/render/pipeline.py,sha256=zwRx28EPH-oOgcttxng_GZEAV2xIfxwZe8wVz_6nTJs,8928
+sphinxnotes/render/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sphinxnotes/render/render.py,sha256=AJWwpvrunCgbfNid0euxfF1AkPV5owlvt0cX93LkfEI,1638
+sphinxnotes/render/sources.py,sha256=WVgySvyIDVIRfweT94vuxapcUgFnsbTmjU0JbtZktR0,3530
+sphinxnotes/render/template.py,sha256=Es4qYDvkqIDW-3E8Y_n5YAAhETf0qZy25Rt4ShBgP6E,4247
+sphinxnotes/render/utils/__init__.py,sha256=cqNoc9loXOEWgB09xN9zflHMO2ALNz2IKPCBQ6zbUes,6750
+sphinxnotes/render/utils/ctxproxy.py,sha256=-dD7IFliyPwXD_50oBAYlbwXmmdkUBiNeHNZbJKzMP0,3589
+sphinxnotes/render/utils/freestyle.py,sha256=aLgfeUnRNxu-GoE2nPpf9GbpO2TXCYz7qsYJev1ud9M,2852
+sphinxnotes_render-1.0a42.dist-info/licenses/LICENSE,sha256=Sa0uIqyOtooTO3N9W29mvi1uHW1uL0lmU7oRYumv8sA,1520
+sphinxnotes_render-1.0a42.dist-info/METADATA,sha256=FXP0Iq0vXtEYJTJR1_mmat83lyBEvSR8Em3CnsYChw4,3055
+sphinxnotes_render-1.0a42.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+sphinxnotes_render-1.0a42.dist-info/top_level.txt,sha256=V-VWtuPpvntuonwz7_KceUnT4-CbPR1gJ26BTFpvcJI,12
+sphinxnotes_render-1.0a42.dist-info/RECORD,,

sphinxnotes_render-1.0a42.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sphinxnotes_render-1.0a42.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Shengyu Zhang
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sphinxnotes_render-1.0a42.dist-info/top_level.txt

@@ -0,0 +1 @@
+sphinxnotes