Dev/0.3.1

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

README.md

@@ -9,9 +9,10 @@
 </p>
 
 <p align="center">
-  <a href="https://pypi.org/project/python-dom/">
-    <img src="https://img.shields.io/pypi/v/pydom.svg" alt="PyPI version">
+  <a href="https://pypi.org/project/pydom/">
+    <img src="https://img.shields.io/pypi/v/pydom.svg?color=32bc31" alt="PyPI Version">
   </a>
+  <img src="https://img.shields.io/pypi/pyversions/pydom.svg?color=32bc31" alt="Supported Python Versions">
 </p>
 
 PyDOM is a Python library that allows you to create web pages using a declarative syntax.

docs/_static/css/custom.css

@@ -0,0 +1,30 @@
+html[data-theme="light"] {
+  --pst-color-primary: #564fa1;
+  --pst-color-secondary: #7f88c3;
+  --pst-color-secondary-hover: #e6e6e6;
+  --pst-color-secondary-highlight: #7f3f98 ;
+}
+
+html[data-theme="dark"] {
+  --pst-color-primary: #7f88c3;
+  --pst-color-secondary: #f7f7f7;
+  --pst-color-secondary-hover: #e6e6e6;
+  --pst-color-secondary-highlight: #7f3f98;
+}
+
+.navbar-brand {
+  gap: 1rem;
+}
+
+.navbar-brand img {
+  height: 85%;
+}
+
+.navbar-item nav {
+  border-left: 2px solid #5d5d5f;
+  padding-left: 8px;
+}
+
+.index-logo {
+  max-width: 250px;
+}

docs/api-reference/index.rst

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+   :titlesonly:
+
+   /api-reference/pydom/index
+
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

docs/api-reference/pydom/component/index.rst

@@ -0,0 +1,43 @@
+pydom.component
+===============
+
+.. py:module:: pydom.component
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   pydom.component.Component
+
+
+Module Contents
+---------------
+
+.. py:class:: Component(*children: pydom.types.rendering.ChildType)
+
+   Bases: :py:obj:`abc.ABC`
+
+
+   Helper class that provides a standard way to create an ABC using
+   inheritance.
+
+
+   .. py:attribute:: children
+      :type:  Tuple[pydom.types.rendering.ChildType, Ellipsis]
+
+
+   .. py:method:: render(*_, **kwargs) -> pydom.types.rendering.RenderResult
+      :abstractmethod:
+
+
+
+   .. py:method:: __init_subclass__(**kwargs) -> None
+      :classmethod:
+
+
+
+   .. py:method:: __call__(*children: pydom.types.rendering.ChildType)
+
+

docs/api-reference/pydom/context/context/index.rst

@@ -0,0 +1,70 @@
+pydom.context.context
+=====================
+
+.. py:module:: pydom.context.context
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   pydom.context.context.T
+   pydom.context.context.P
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   pydom.context.context.Context
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   pydom.context.context.get_context
+   pydom.context.context.set_default_context
+
+
+Module Contents
+---------------
+
+.. py:data:: T
+
+.. py:data:: P
+
+.. py:class:: Context
+
+   .. py:attribute:: injector
+      :type:  pydom.utils.injector.Injector
+
+
+   .. py:method:: add_prop_transformer(transformer: pydom.context.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
+                  add_prop_transformer(matcher: pydom.context.transformers.PropertyMatcherFunction, transformer: pydom.context.transformers.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
+
+
+   .. py:method:: add_post_render_transformer(transformer: Union[pydom.context.transformers.PostRenderTransformerFunction, pydom.context.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
+
+
+   .. py:property:: prop_transformers
+
+
+   .. py:property:: post_render_transformers
+
+
+   .. py:method:: inject(callback: Callable) -> Callable
+
+
+   .. py:method:: standard() -> typing_extensions.Self
+      :classmethod:
+
+
+
+.. py:function:: get_context(context: Optional[Context] = None) -> Context
+
+.. py:function:: set_default_context(context: Context) -> None
+

docs/api-reference/pydom/context/feature/index.rst

@@ -0,0 +1,27 @@
+pydom.context.feature
+=====================
+
+.. py:module:: pydom.context.feature
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   pydom.context.feature.Feature
+
+
+Module Contents
+---------------
+
+.. py:class:: Feature(context: pydom.context.context.Context)
+
+   .. py:attribute:: context
+
+
+   .. py:property:: feature_name
+      :type: str
+
+
+

docs/api-reference/pydom/context/index.rst

@@ -0,0 +1,66 @@
+pydom.context
+=============
+
+.. py:module:: pydom.context
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /api-reference/pydom/context/context/index
+   /api-reference/pydom/context/feature/index
+   /api-reference/pydom/context/standard/index
+   /api-reference/pydom/context/transformers/index
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   pydom.context.Context
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   pydom.context.get_context
+
+
+Package Contents
+----------------
+
+.. py:class:: Context
+
+   .. py:attribute:: injector
+      :type:  pydom.utils.injector.Injector
+
+
+   .. py:method:: add_prop_transformer(transformer: pydom.context.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
+                  add_prop_transformer(matcher: pydom.context.transformers.PropertyMatcherFunction, transformer: pydom.context.transformers.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
+
+
+   .. py:method:: add_post_render_transformer(transformer: Union[pydom.context.transformers.PostRenderTransformerFunction, pydom.context.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
+
+
+   .. py:property:: prop_transformers
+
+
+   .. py:property:: post_render_transformers
+
+
+   .. py:method:: inject(callback: Callable) -> Callable
+
+
+   .. py:method:: standard() -> typing_extensions.Self
+      :classmethod:
+
+
+
+.. py:function:: get_context(context: Optional[Context] = None) -> Context
+

docs/api-reference/pydom/context/standard/index.rst

@@ -0,0 +1,28 @@
+pydom.context.standard
+======================
+
+.. py:module:: pydom.context.standard
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /api-reference/pydom/context/standard/transformers/index
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   pydom.context.standard.add_standard_features
+
+
+Package Contents
+----------------
+
+.. py:function:: add_standard_features(ctx: pydom.context.context.Context)
+