sphinxnotes-project 1.0a48__tar.gz → 1.0a50__tar.gz

{sphinxnotes_project-1.0a48/src/sphinxnotes_project.egg-info → sphinxnotes_project-1.0a50}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinxnotes-project
-Version: 1.0a48
+Version: 1.0a50
 Summary: A Sphinx extension that provides useful directives for creating project documentation
 Author: Shengyu Zhang
 Maintainer: Shengyu Zhang
@@ -25,6 +25,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: Sphinx>=7.0
 Requires-Dist: sphinxnotes-any>=3.0b0
+Requires-Dist: sphinxnotes-render
 Requires-Dist: sphinx_design
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"

{sphinxnotes_project-1.0a48 → sphinxnotes_project-1.0a50}/pyproject.toml

@@ -43,6 +43,7 @@ dependencies = [
 
     # CUSTOM DEPENDENCIES START
     "sphinxnotes-any >= 3.0b0",
+    "sphinxnotes-render",
     "sphinx_design",
     # CUSTOM DEPENDENCIES END
 ]

{sphinxnotes_project-1.0a48 → sphinxnotes_project-1.0a50}/src/sphinxnotes/project/sphinxnotes_any.py

@@ -15,7 +15,6 @@ from typing import TYPE_CHECKING
 from os import path
 
 from sphinx.config import ENUM
-from sphinx.errors import ConfigError
 
 if TYPE_CHECKING:
     from sphinx.application import Sphinx
@@ -40,14 +39,6 @@ def _read_template_file(name: str) -> str:
     return open(_get_template_file(name), 'r').read()
 
 
-def _validate_project_example_style(style: str) -> str:
-    if style not in {'tab', 'grid'}:
-        raise ConfigError(
-            'The "project_example_style" config value must be "tab" or "grid".'
-        )
-    return style
-
-
 ANY_OBJECT_TYPES = {
     'version': {
         'schema': {
@@ -77,10 +68,6 @@ ANY_OBJECT_TYPES = {
 
 
 def _config_inited(app: Sphinx, config: Config) -> None:
-    config.project_example_style = _validate_project_example_style(
-        config.project_example_style
-    )
-
     if v := config.any_object_types:
         v.update(ANY_OBJECT_TYPES)
     else:
@@ -92,9 +79,9 @@ def setup(app: Sphinx):
     app.setup_extension('sphinxnotes.any')
     app.add_config_value(
         'project_example_style',
-        'grid',
+        'split',
         'env',
-        types=ENUM('tab', 'grid'),
+        types=ENUM('tab', 'grid', 'split', 'stack'),
     )
     # Should have priority over sphinxnotes.any's "config-inited" callback.
     app.connect('config-inited', _config_inited, priority=400)

sphinxnotes_project-1.0a50/src/sphinxnotes/project/templates/example.rst

@@ -0,0 +1,50 @@
+{% macro render_source(content) %}
+      .. code:: rst
+
+         {% for line in content.split('\n') -%}
+         {{ line }}
+         {% endfor %}
+{% endmacro %}
+
+{% macro render_result(content) %}
+      {% for line in content.split('\n') -%}
+      {{ line }}
+      {% endfor %}
+{% endmacro %}
+
+{% set _style = style or load_extra('env').config.project_example_style %}
+
+{% if _style == 'tab' %}
+.. tab-set::
+
+   .. tab-item:: Result
+
+      {{ render_result(content) }}
+
+   .. tab-item:: Source
+
+      {{ render_source(content) }}
+
+{% elif _style in ['grid', 'split', 'stack'] %}
+.. grid:: {% if _style == 'stack' %}1 1 1 1{% else %}1 1 2 2{% endif %}
+   :gutter: 1
+   :margin: 0
+   :padding: 0
+
+   .. grid-item-card:: Source
+      :margin: 0
+
+      {{ render_source(content) }}
+
+   .. grid-item-card:: Result
+      :margin: 0
+
+      {{ render_result(content) }}
+
+{% else %}
+
+.. error::
+
+   Unkown example style ``{{ _style }}``.
+
+{% endif %}

{sphinxnotes_project-1.0a48 → sphinxnotes_project-1.0a50/src/sphinxnotes_project.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinxnotes-project
-Version: 1.0a48
+Version: 1.0a50
 Summary: A Sphinx extension that provides useful directives for creating project documentation
 Author: Shengyu Zhang
 Maintainer: Shengyu Zhang
@@ -25,6 +25,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: Sphinx>=7.0
 Requires-Dist: sphinxnotes-any>=3.0b0
+Requires-Dist: sphinxnotes-render
 Requires-Dist: sphinx_design
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"

{sphinxnotes_project-1.0a48 → sphinxnotes_project-1.0a50}/src/sphinxnotes_project.egg-info/requires.txt

@@ -1,5 +1,6 @@
 Sphinx>=7.0
 sphinxnotes-any>=3.0b0
+sphinxnotes-render
 sphinx_design
 
 [dev]

sphinxnotes_project-1.0a48/src/sphinxnotes/project/templates/example.rst

@@ -1,39 +0,0 @@
-{% set effective_style = style or load_extra('env').config.project_example_style %}
-{% if effective_style == 'tab' %}
-.. tab-set::
-
-   .. tab-item:: Result
-
-      {% for line in content.split('\n') -%}
-      {{ line }}
-      {% endfor %}
-
-   .. tab-item:: Source
-
-      .. code:: rst
-
-         {% for line in content.split('\n') -%}
-         {{ line }}
-         {% endfor %}
-{% elif effective_style == 'grid'  %}
-.. grid:: 1 1 2 2
-   :gutter: 1
-   :margin: 0
-   :padding: 0
-
-   .. grid-item-card:: Source
-      :margin: 0
-
-      .. code:: rst
-
-         {% for line in content.split('\n') -%}
-         {{ line }}
-         {% endfor %}
-
-   .. grid-item-card:: Result
-      :margin: 0
-
-      {% for line in content.split('\n') -%}
-      {{ line }}
-      {% endfor %}
-{% endif %}