From 8370be5b84b0c830709e98ca4b34e2e703bd59c3 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Wed, 3 Dec 2025 14:31:57 +0100 Subject: [PATCH 01/10] basic mkdocs configs and dependencies --- mkdocs.yml | 137 +++++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 42 +++++++++++++-- 2 files changed, 176 insertions(+), 3 deletions(-) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..3a89a2e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,137 @@ +site_name: COMPAS Protobuf +site_url: https://github.com/gramaziokohler/compas_pb + +repo_name: gramaziokohler +repo_url: https://github.com/gramaziokohler/compas_pb + +copyright: Copyright © 2024 - 2025, ETH Zurich - Gramazio Kohler Research + +extra: + homepage: https://gramaziokohler.github.io/compas_pb/ + version: + provider: mike + +theme: + name: material + palette: + scheme: slate + primary: indigo + accent: indigo + font: + text: Roboto + code: Roboto Mono + logo: assets/images/compas_icon_white.png + favicon: public/favicon.ico + features: + - content.code.copy + - content.footnote.tooltips + - navigation.expand + - navigation.footer + - navigation.indexes + - navigation.sections + - navigation.top + - search.highlight + - search.suggest + - toc.follow + +markdown_extensions: + - abbr + - attr_list + - admonition + - callouts: + strip_period: no + - footnotes + - md_in_html + - pymdownx.blocks.caption + - pymdownx.caret + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.keys + - pymdownx.mark + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets: + check_paths: true + - pymdownx.superfences + - toc: + permalink: "¤" + +plugins: + - search + - mkdocstrings: + default_handler: python + handlers: + python: + paths: [src] # search packages in the src folder + inventories: + - https://docs.python.org/3/objects.inv + - https://compas.dev/compas/latest/objects.inv + options: + allow_inspection: true + backlinks: tree + docstring_options: + ignore_init_summary: true + trim_doctest_flags: true + docstring_style: numpy + docstring_section_style: list + filters: public + group_by_category: true + heading_level: 1 + inheritance_diagram_direction: TD + inherited_members: false + line_length: 88 + merge_init_into_class: true + modernize_annotations: true + parameter_headings: false + preload_modules: [mkdocstrings, compas] + relative_crossrefs: true + scoped_crossrefs: true + separate_signature: true + show_bases: false + show_category_heading: true + show_docstring_attributes: true + show_docstring_functions: true + show_docstring_modules: false + show_if_no_docstring: false + show_inheritance_diagram: false + show_root_heading: true + show_root_full_path: true + show_signature: true + show_signature_annotations: true + show_signature_type_parameters: true + show_source: false + show_submodules: false + show_symbol_type_heading: true + show_symbol_type_toc: true + signature_crossrefs: true + summary: + modules: false + type_parameter_headings: true + unwrap_annotated: true + + +# TODO: update for this project +nav: + - Home: index.md + - Get Started: + - Introduction: introduction.md + - Installation: installation.md + - Reference: + - algorithms: reference/compas_model.algorithms.md + - datastructures: reference/compas_model.datastructures.md + - geometry: reference/compas_model.geometry.md + - interactions: reference/compas_model.interactions.md + - materials: reference/compas_model.materials.md + - models: reference/compas_model.models.md + - modifiers: reference/compas_model.modifiers.md + - scene: reference/compas_model.scene.md + - viewer: reference/compas_model.viewer.md + - Other: + - changelog.md \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index f4da4b8..7390b9c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,7 @@ authors = [ license = { file = "LICENSE" } readme = "README.md" requires-python = ">=3.9" -dynamic = ['dependencies', 'optional-dependencies', 'version'] +dynamic = ['version'] classifiers = [ "Development Status :: 4 - Beta", "Topic :: Scientific/Engineering", @@ -30,6 +30,42 @@ classifiers = [ "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", ] +dependencies = [ + "compas >=2", + "protobuf >=6.31.1", + "importlib-metadata>=5; python_version == '3.9'", +] + +[project.optional-dependencies] +dev = [ + "attrs >=17.4", + "bump-my-version", + "compas_invocations2", + "invoke >=0.14", + "ruff", + "sphinx_compas2_theme", + "twine", + "wheel", + "pytest-mock", + "build", +] +docs = [ + "markdown-callouts >=0.4", + "markdown-exec >=1.8", + "mike", + "mkdocs >=1.6", + "mkdocs-autorefs >=1.4", + "mkdocs-coverage >=1.0", + "mkdocs-git-revision-date-localized-plugin >=1.2", + "mkdocs-llmstxt >=0.2", + "mkdocs-material >=9.5", + "mkdocs-minify-plugin >=0.8", + "mkdocs-redirects >=1.2", + "mkdocs-section-index >=0.3", + "mkdocstrings[python]", + "pydantic >=2.10", + "tomli >=2.0; python_version < '3.11'", +] [project.urls] Homepage = "https://gramaziokohler.github.io/compas_pb" @@ -50,8 +86,8 @@ zip-safe = false [tool.setuptools.dynamic] version = { attr = "compas_pb.__version__" } -dependencies = { file = "requirements.txt" } -optional-dependencies = { dev = { file = "requirements-dev.txt" } } + + [tool.setuptools.packages.find] where = ["src"] From cf7af19f7bf977df856ca58c6a9029acc759110b Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Mon, 8 Dec 2025 17:25:29 +0100 Subject: [PATCH 02/10] api reference --- docs/reference/compas_pb.conversions.md | 2 ++ docs/reference/compas_pb.core.md | 1 + docs/reference/compas_pb.md | 1 + docs/reference/compas_pb.registry.md | 1 + mkdocs.yml | 16 +++++----------- 5 files changed, 10 insertions(+), 11 deletions(-) create mode 100644 docs/reference/compas_pb.conversions.md create mode 100644 docs/reference/compas_pb.core.md create mode 100644 docs/reference/compas_pb.md create mode 100644 docs/reference/compas_pb.registry.md diff --git a/docs/reference/compas_pb.conversions.md b/docs/reference/compas_pb.conversions.md new file mode 100644 index 0000000..9b383ad --- /dev/null +++ b/docs/reference/compas_pb.conversions.md @@ -0,0 +1,2 @@ +# ::: compas_pb.conversions + diff --git a/docs/reference/compas_pb.core.md b/docs/reference/compas_pb.core.md new file mode 100644 index 0000000..c45d79a --- /dev/null +++ b/docs/reference/compas_pb.core.md @@ -0,0 +1 @@ +# ::: compas_pb.core \ No newline at end of file diff --git a/docs/reference/compas_pb.md b/docs/reference/compas_pb.md new file mode 100644 index 0000000..158cf18 --- /dev/null +++ b/docs/reference/compas_pb.md @@ -0,0 +1 @@ +# ::: compas_pb diff --git a/docs/reference/compas_pb.registry.md b/docs/reference/compas_pb.registry.md new file mode 100644 index 0000000..830f836 --- /dev/null +++ b/docs/reference/compas_pb.registry.md @@ -0,0 +1 @@ +# ::: compas_pb.registry diff --git a/mkdocs.yml b/mkdocs.yml index 3a89a2e..461cf57 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -117,21 +117,15 @@ plugins: unwrap_annotated: true -# TODO: update for this project nav: - Home: index.md - Get Started: - Introduction: introduction.md - Installation: installation.md - - Reference: - - algorithms: reference/compas_model.algorithms.md - - datastructures: reference/compas_model.datastructures.md - - geometry: reference/compas_model.geometry.md - - interactions: reference/compas_model.interactions.md - - materials: reference/compas_model.materials.md - - models: reference/compas_model.models.md - - modifiers: reference/compas_model.modifiers.md - - scene: reference/compas_model.scene.md - - viewer: reference/compas_model.viewer.md + - API Reference: + - compas_pb: reference/compas_pb.md + - compas_pb.core: reference/compas_pb.core.md + - compas_pb.registry: reference/compas_pb.registry.md + - compas_pb.conversions: reference/compas_pb.conversions.md - Other: - changelog.md \ No newline at end of file From 2b51cc227319ae3dfc116a697efab5aa85188087 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Mon, 8 Dec 2025 17:53:42 +0100 Subject: [PATCH 03/10] removed the old sphinx stuff --- docs/_images/PLACEHOLDER | 1 - docs/api.rst | 11 - docs/api/compas_pb.conversions.rst | 75 -- docs/api/compas_pb.core.rst | 24 - docs/api/compas_pb.registry.rst | 17 - docs/api/compas_pb.rst | 21 - docs/assets/images/compas_pb.svg | 1 + docs/changelog.md | 1 + docs/conf.py | 160 ---- docs/examples.md | 59 ++ docs/examples.rst | 67 -- docs/examples/PLACEHOLDER | 0 docs/index.md | 71 ++ docs/index.rst | 90 -- docs/installation.md | 29 + docs/installation.rst | 36 - docs/introduction.md | 57 ++ docs/license.md | 3 + docs/license.rst | 5 - docs/missing_compas_type.md | 68 ++ docs/missing_compas_type.rst | 79 -- docs/protobuf.md | 1295 ++++++++++++++++++++++++++++ mkdocs.yml | 6 +- src/compas_pb/invocations.py | 11 +- 24 files changed, 1594 insertions(+), 593 deletions(-) delete mode 100644 docs/_images/PLACEHOLDER delete mode 100644 docs/api.rst delete mode 100644 docs/api/compas_pb.conversions.rst delete mode 100644 docs/api/compas_pb.core.rst delete mode 100644 docs/api/compas_pb.registry.rst delete mode 100644 docs/api/compas_pb.rst create mode 100644 docs/assets/images/compas_pb.svg create mode 100644 docs/changelog.md delete mode 100644 docs/conf.py create mode 100644 docs/examples.md delete mode 100644 docs/examples.rst delete mode 100644 docs/examples/PLACEHOLDER create mode 100644 docs/index.md delete mode 100644 docs/index.rst create mode 100644 docs/installation.md delete mode 100644 docs/installation.rst create mode 100644 docs/introduction.md create mode 100644 docs/license.md delete mode 100644 docs/license.rst create mode 100644 docs/missing_compas_type.md delete mode 100644 docs/missing_compas_type.rst create mode 100644 docs/protobuf.md diff --git a/docs/_images/PLACEHOLDER b/docs/_images/PLACEHOLDER deleted file mode 100644 index 48f73eb..0000000 --- a/docs/_images/PLACEHOLDER +++ /dev/null @@ -1 +0,0 @@ -# container for images to be included in the docs diff --git a/docs/api.rst b/docs/api.rst deleted file mode 100644 index d581f5e..0000000 --- a/docs/api.rst +++ /dev/null @@ -1,11 +0,0 @@ -******************************************************************************** -API Reference -******************************************************************************** - -.. toctree:: - :maxdepth: 1 - - api/compas_pb - api/compas_pb.core - api/compas_pb.registry - api/compas_pb.conversions diff --git a/docs/api/compas_pb.conversions.rst b/docs/api/compas_pb.conversions.rst deleted file mode 100644 index 00ee70f..0000000 --- a/docs/api/compas_pb.conversions.rst +++ /dev/null @@ -1,75 +0,0 @@ -******************************************************************************** -compas_pb.conversions -******************************************************************************** - -.. currentmodule:: compas_pb.conversions - -This module provides conversion functions for COMPAS geometry objects to and from Protocol Buffer messages. - -Functions -========= - -.. autosummary:: - :toctree: generated/ - :nosignatures: - - point_to_pb - point_from_pb - vector_to_pb - vector_from_pb - line_to_pb - line_from_pb - frame_to_pb - frame_from_pb - mesh_to_pb - mesh_from_pb - circle_to_pb - circle_from_pb - plane_to_pb - plane_from_pb - polygon_to_pb - polygon_from_pb - box_to_pb - box_from_pb - arc_to_pb - arc_from_pb - sphere_to_pb - sphere_from_pb - cylinder_to_pb - cylinder_from_pb - cone_to_pb - cone_from_pb - torus_to_pb - torus_from_pb - ellipse_to_pb - ellipse_from_pb - polyline_to_pb - polyline_from_pb - pointcloud_to_pb - pointcloud_from_pb - transformation_to_pb - transformation_from_pb - translation_to_pb - translation_from_pb - rotation_to_pb - rotation_from_pb - capsule_to_pb - capsule_from_pb - quaternion_to_pb - quaternion_from_pb - scale_to_pb - scale_from_pb - reflection_to_pb - reflection_from_pb - shear_to_pb - shear_from_pb - projection_to_pb - projection_from_pb - bezier_to_pb - bezier_from_pb - hyperbola_to_pb - hyperbola_from_pb - parabola_to_pb - parabola_from_pb - polyhedron_to_pb - polyhedron_from_pb diff --git a/docs/api/compas_pb.core.rst b/docs/api/compas_pb.core.rst deleted file mode 100644 index b2e23a5..0000000 --- a/docs/api/compas_pb.core.rst +++ /dev/null @@ -1,24 +0,0 @@ -******************************************************************************** -compas_pb.core -******************************************************************************** - -.. currentmodule:: compas_pb.core - -This module contains the core classes for Protocol Buffer data conversion. - -Functions -========= - -.. autosummary:: - :toctree: generated/ - :nosignatures: - - primitive_to_pb - primitive_from_pb - any_to_pb - any_from_pb - serialize_message_to_json - deserialize_message_from_json - serialize_message_bts - deserialize_message_bts - diff --git a/docs/api/compas_pb.registry.rst b/docs/api/compas_pb.registry.rst deleted file mode 100644 index 6f3c6eb..0000000 --- a/docs/api/compas_pb.registry.rst +++ /dev/null @@ -1,17 +0,0 @@ -******************************************************************************** -compas_pb.registry -******************************************************************************** - -.. currentmodule:: compas_pb.registry - -This module provides the registry system for serializers and deserializers. - -Classes -======= - -.. autosummary:: - :toctree: generated/ - :nosignatures: - - PbSerializerRegistrationError - SerializerRegistry diff --git a/docs/api/compas_pb.rst b/docs/api/compas_pb.rst deleted file mode 100644 index af04087..0000000 --- a/docs/api/compas_pb.rst +++ /dev/null @@ -1,21 +0,0 @@ -******************************************************************************** -compas_pb -******************************************************************************** - -.. currentmodule:: compas_pb - -This module provides high-level functions for reading and writing COMPAS objects to and from files using Protocol Buffers. - -Functions -========= - -.. autosummary:: - :toctree: generated/ - :nosignatures: - - pb_dump - pb_load - pb_dump_bts - pb_load_bts - pb_dump_json - pb_load_json diff --git a/docs/assets/images/compas_pb.svg b/docs/assets/images/compas_pb.svg new file mode 100644 index 0000000..1cb4e7c --- /dev/null +++ b/docs/assets/images/compas_pb.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..786b75d --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +--8<-- "CHANGELOG.md" diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index b0560cd..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,160 +0,0 @@ -# flake8: noqa -# -*- coding: utf-8 -*- - -from sphinx.writers import html, html5 -import sphinx_compas2_theme - -# -- General configuration ------------------------------------------------ - -project = "compas_pb" -copyright = "Gramazio Kohler Research" -author = "Chen Kasirer" -package = "compas_pb" -organization = "gramaziokohler" - -master_doc = "index" -source_suffix = {".rst": "restructuredtext", ".md": "markdown"} -templates_path = sphinx_compas2_theme.get_autosummary_templates_path() -exclude_patterns = sphinx_compas2_theme.default_exclude_patterns -add_module_names = True -language = "en" - -latest_version = sphinx_compas2_theme.get_latest_version() - -if latest_version == "Unreleased": - release = "Unreleased" - version = "latest" -else: - release = latest_version - version = ".".join(release.split(".")[0:2]) # type: ignore - -# -- Extension configuration ------------------------------------------------ - -extensions = sphinx_compas2_theme.default_extensions -extensions.remove("sphinx.ext.linkcode") - -# numpydoc options - -numpydoc_show_class_members = False -numpydoc_class_members_toctree = False -numpydoc_attributes_as_param_list = True - -# bibtex options - -# autodoc options - -autodoc_type_aliases = {} - -autodoc_typehints = "description" -autodoc_typehints_format = "short" -autodoc_typehints_description_target = "documented" - -autodoc_mock_imports = sphinx_compas2_theme.default_mock_imports - -autodoc_default_options = { - "undoc-members": True, - "show-inheritance": True, -} - -autodoc_member_order = "groupwise" - -autoclass_content = "class" - - -def setup(app): - app.connect("autodoc-skip-member", sphinx_compas2_theme.skip) - - -# autosummary options - -autosummary_generate = True -autosummary_mock_imports = sphinx_compas2_theme.default_mock_imports - -# graph options - -# plot options - -# intersphinx options - -intersphinx_mapping = { - "python": ("https://docs.python.org/", None), - "compas": ("https://compas.dev/compas/latest/", None), -} - -# linkcode - -linkcode_resolve = sphinx_compas2_theme.get_linkcode_resolve(organization, package) - -# extlinks - -extlinks = {} - -# from pytorch - -sphinx_compas2_theme.replace(html.HTMLTranslator) -sphinx_compas2_theme.replace(html5.HTML5Translator) - -# -- Options for HTML output ---------------------------------------------- - -html_theme = "sidebaronly" -html_title = project - -favicons = [ - { - "rel": "icon", - "href": "compas.ico", - } -] - -html_theme_options = { - "icon_links": [ - { - "name": "GitHub", - "url": f"https://github.com/{organization}/{package}", - "icon": "fa-brands fa-github", - "type": "fontawesome", - }, - { - "name": "Discourse", - "url": "http://forum.compas-framework.org/", - "icon": "fa-brands fa-discourse", - "type": "fontawesome", - }, - { - "name": "PyPI", - "url": f"https://pypi.org/project/{package}/", - "icon": "fa-brands fa-python", - "type": "fontawesome", - }, - ], - "switcher": { - "json_url": f"https://raw.githubusercontent.com/{organization}/{package}/gh-pages/versions.json", - "version_match": version, - }, - "check_switcher": False, - "logo": { - "image_light": "_static/compas_icon_white.png", - "image_dark": "_static/compas_icon_white.png", - "text": project, - }, - "navigation_depth": 3, -} - - -html_context = { - "github_url": "https://github.com", - "github_user": organization, - "github_repo": package, - "github_version": "main", - "doc_path": "docs", -} - -html_static_path = sphinx_compas2_theme.get_html_static_path() + ["_static"] -html_css_files = [] -html_extra_path = [] -html_last_updated_fmt = "" -html_copy_source = False -html_show_sourcelink = True -html_permalinks = False -html_permalinks_icon = "" -html_compact_lists = True diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000..53e2ad2 --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,59 @@ +# Examples + +`compas_pb` lets you serialize and de-serialize arbitrarily nested COMPAS types and python builtins. + +## Serialization to file + +Serialize and deserialize basic COMPAS geometry objects: + +```python +from compas.datastructures import Mesh +from compas.geometry import Box +from compas_pb import pb_dump +from compas_pb import pb_load + +box = Box.from_width_height_depth(1.0, 2.0, 3.0) +mesh = Mesh.from_shape(box) + +PATH = r"box_mesh.data" + +pb_dump({"box": box, "mesh": mesh}, PATH) + +data = pb_load(PATH) + +box = data["box"] +mesh = data["mesh"] +``` + +## Serialization to bytes + +```python +from compas.datastructures import Mesh +from compas.geometry import Box +from compas_pb import pb_dump_bts + +from spaceship_controller import space_interface + +box = Box.from_width_height_depth(1.0, 2.0, 3.0) +mesh = Mesh.from_shape(box) + +message = pb_dump_bts({"box": box, "mesh": mesh}) + +space_interface.send_bytes(message) +``` + +Or, if you don't have a spaceship: + +```python +from compas.datastructures import Mesh +from compas.geometry import Box +from compas_pb import pb_dump_bts +from compas_pb import pb_load_bts + +box = Box.from_width_height_depth(1.0, 2.0, 3.0) +mesh = Mesh.from_shape(box) + +message = pb_dump_bts({"box": box, "mesh": mesh}) + +data = pb_load_bts(message) +``` diff --git a/docs/examples.rst b/docs/examples.rst deleted file mode 100644 index a64623a..0000000 --- a/docs/examples.rst +++ /dev/null @@ -1,67 +0,0 @@ -******************************************************************************** -Examples -******************************************************************************** - -``compas_pb`` lets you serialize and de-serialize arbitrarily nested COMPAS types and python builtins. - -Serialization to file -===================== - -Serialize and deserialize basic COMPAS geometry objects: - -.. code-block:: python - - from compas.datastructures import Mesh - from compas.geometry import Box - from compas_pb import pb_dump - from compas_pb import pb_load - - box = Box.from_width_height_depth(1.0, 2.0, 3.0) - mesh = Mesh.from_shape(box) - - PATH = r"box_mesh.data" - - pb_dump({"box": box, "mesh": mesh}, PATH) - - data = pb_load(PATH) - - box = data["box"] - mesh = data["mesh"] - - -Serialization to bytes -====================== - - -.. code-block:: python - - from compas.datastructures import Mesh - from compas.geometry import Box - from compas_pb import pb_dump_bts - - from spaceship_controller import space_interface - - box = Box.from_width_height_depth(1.0, 2.0, 3.0) - mesh = Mesh.from_shape(box) - - message = pb_dump_bts({"box": box, "mesh": mesh}) - - space_interface.send_bytes(message) - - -Or, if you don't have a spaceship: - -.. code-block:: python - - from compas.datastructures import Mesh - from compas.geometry import Box - from compas_pb import pb_dump_bts - from compas_pb import pb_load_bts - - box = Box.from_width_height_depth(1.0, 2.0, 3.0) - mesh = Mesh.from_shape(box) - - message = pb_dump_bts({"box": box, "mesh": mesh}) - - data = pb_load_bts(message) - diff --git a/docs/examples/PLACEHOLDER b/docs/examples/PLACEHOLDER deleted file mode 100644 index e69de29..0000000 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..1486729 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,71 @@ +# COMPAS Protobuf + +

+ COMPAS Protobuf Logo +

+ +

+A COMPAS extension which lets you serialize and deserialize COMPAS Data types using protobuf. +

+ +## Installation + +Stable releases can be installed from PyPI. + +```bash +pip install compas_pb +``` + +## Basic Usage + +### Serialize to file + +```python +from compas.geometry import Vector +from compas_pb import pb_dump +from compas_pb import pb_load + +PATH = "vector.data" + +vector = Vector(1.0, 2.0, 3.0) + +pb_dump(vector, PATH) + +loaded_vector = pb_load(PATH) +``` + +### (De)serialize to bytes + +```python +from compas.geometry import Vector +from compas_pb import pb_dump_bts +from compas_pb import pb_load_bts + +vector = Vector(1.0, 2.0, 3.0) + +bytes_vector = pb_dump_bts(vector) + +loaded_vector = pb_load_bts(bytes_vector) +``` + +### Serialization of arbitrarily nested data structures + +```python +from compas.geometry import Vector +from compas.geometry import Polyline +from compas_pb import pb_dump_bts +from compas_pb import pb_load_bts + +data = { + "direction": Vector(1.0, 2.0, 3.0), + "outlines": + [ + Polyline([[0, 0, 0], [1, 1, 1], [2, 2, 2]]), + Polyline([[3, 3, 3], [4, 4, 4], [5, 5, 5]]) + ], +} + +pb_data = pb_dump_bts(data) + +loaded_data = pb_load_bts(pb_data) +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 576fbca..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,90 +0,0 @@ - -.. image:: ../compas_pb.svg - :width: 400px - :align: center - -.. rst-class:: lead - -A COMPAS extension which lets you serialize and deserialize COMPAS `Data` types using protobuf. - -Installation -============ - -Stable releases can be installed from PyPI. - -.. code-block:: bash - - pip install compas_pb - -Basic Usage -=========== - -Serialize to file ------------------ - -.. code-block:: python - - from compas.geometry import Vector - from compas_pb import pb_dump - from compas_pb import pb_load - - PATH = "vector.data" - - vector = Vector(1.0, 2.0, 3.0) - - pb_dump(vector, PATH) - - loaded_vector = pb_load(PATH) - -(De)serialize to bytes ----------------------- - -.. code-block:: python - - from compas.geometry import Vector - from compas_pb import pb_dump_bts - from compas_pb import pb_load_bts - - vector = Vector(1.0, 2.0, 3.0) - - bytes_vector = pb_dump_bts(vector) - - loaded_vector = pb_load_bts(bytes_vector) - -Serialization of arbitrarily nested data structures ----------------------------------------------------- - -.. code-block:: python - - from compas.geometry import Vector - from compas.geometry import Polyline - from compas_pb import pb_dump_bts - from compas_pb import pb_load_bts - - data = { - "direction": Vector(1.0, 2.0, 3.0), - "outlines": - [ - Polyline([[0, 0, 0], [1, 1, 1], [2, 2, 2]]), - Polyline([[3, 3, 3], [4, 4, 4], [5, 5, 5]]) - ], - } - - pb_data = pb_dump_bts(data) - - loaded_data = pb_load_bts(pb_data) - -Table of Contents -================= - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - Introduction - installation - missing_compas_type - examples - api - protobuf - license diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..e39a625 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,29 @@ +# Installation + +## Stable + +Stable releases are available on PyPI and can be installed with pip. + +```bash +pip install compas_pb +``` + +## Latest + +The latest version can be installed from local source. + +```bash +git clone https://github.com/gramaziokohler/compas_pb.git +cd compas_pb +pip install -e . +``` + +## Development + +To install `compas_pb` for development, install from local source with the "dev" requirements. + +```bash +git clone https://github.com/gramaziokohler/compas_pb.git +cd compas_pb +pip install -e .[dev] +``` diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index a90bdbc..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,36 +0,0 @@ -******************************************************************************** -Installation -******************************************************************************** - -Stable -====== - -Stable releases are available on PyPI and can be installed with pip. - -.. code-block:: bash - - pip install compas_pb - - -Latest -====== - -The latest version can be installed from local source. - -.. code-block:: bash - - git clone https://github.com/gramaziokohler/compas_pb.git - cd compas_pb - pip install -e . - - -Development -=========== - -To install `compas_pb` for development, install from local source with the "dev" requirements. - -.. code-block:: bash - - git clone https://github.com/gramaziokohler/compas_pb.git - cd compas_pb - pip install -e .[dev] diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..8b42210 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,57 @@ +# Introduction + +A COMPAS extension which lets you serialize and deserialize COMPAS `Data` types using protobuf. + +## Basic Usage + +### Serialize to file + +```python +from compas.geometry import Vector +from compas_pb import pb_dump +from compas_pb import pb_load + +PATH = "vector.data" + +vector = Vector(1.0, 2.0, 3.0) + +pb_dump(vector, PATH) + +loaded_vector = pb_load(PATH) +``` + +### (De)serialize to bytes + +```python +from compas.geometry import Vector +from compas_pb import pb_dump_bts +from compas_pb import pb_load_bts + +vector = Vector(1.0, 2.0, 3.0) + +bytes_vector = pb_dump_bts(vector) + +loaded_vector = pb_load_bts(bytes_vector) +``` + +### Serialization of arbitrarily nested data structures + +```python +from compas.geometry import Vector +from compas.geometry import Polyline +from compas_pb import pb_dump_bts +from compas_pb import pb_load_bts + +data = { + "direction": Vector(1.0, 2.0, 3.0), + "outlines": + [ + Polyline([[0, 0, 0], [1, 1, 1], [2, 2, 2]]), + Polyline([[3, 3, 3], [4, 4, 4], [5, 5, 5]]) + ], +} + +pb_data = pb_dump_bts(data) + +loaded_data = pb_load_bts(pb_data) +``` diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..0e8c6fc --- /dev/null +++ b/docs/license.md @@ -0,0 +1,3 @@ +# License + +--8<-- "LICENSE" diff --git a/docs/license.rst b/docs/license.rst deleted file mode 100644 index e6a80ce..0000000 --- a/docs/license.rst +++ /dev/null @@ -1,5 +0,0 @@ -******************************************************************************** -License -******************************************************************************** - -.. literalinclude:: ../LICENSE diff --git a/docs/missing_compas_type.md b/docs/missing_compas_type.md new file mode 100644 index 0000000..6957a2a --- /dev/null +++ b/docs/missing_compas_type.md @@ -0,0 +1,68 @@ +# Missing COMPAS Type? + +!!! note + We're doing our best to add support for as many COMPAS types as possible. Is the type you'd like to send still missing? Helps us out by adding it yourself! + +This guide explains how to extend compas_pb with support for more COMPAS types. + +## Creating New Serializers + +### 1. Create a protobuf definition for the type you wish to add (for example `Circle`) + +Create a protobuf definition for the new type you wish to add. This should be placed in `IDL/compas_pb/generated/`. + +```protobuf title="IDL/compas_pb/generated/custom_point.proto" +syntax = "proto3"; + +package compas_pb.data; + +import "compas_pb/generated/frame.proto"; + +message CircleData { + string guid = 1; + string name = 2; + float radius = 3; + FrameData frame = 4; +} +``` + +### 3. Generate the python code for the new type + +Now run the following command to generate the python code: + +```bash +invoke protobuf.generate-proto-classes -t python +``` + +A new module called `circle_pb2` should now be available in `compas_pb/generated/`. + +### 4. Create a (de)serializer for the new type + +To create a (de)serializer for a custom type, use the `@pb_serializer` and `@pb_deserializer` decorators. These decorators will be used to register the serializer and deserializer with the plugin system. + +```python title="compas_pb/conversions.py" +from compas_pb.data import pb_serializer +from compas_pb.data import pb_deserializer +from compas_pb.generated import circle_pb2 + + +@pb_serializer(Circle) +def my_circle_to_pb(obj: Circle) -> circle_pb2.CircleData: + """Convert Circle to protobuf message.""" + result = circle_pb2.CircleData() + result.guid = obj.guid + result.name = obj.name + result.radius = obj.radius + result.frame = frame_to_pb(obj.frame) + return result + +@pb_deserializer(circle_pb2.CircleData) +def my_circle_from_pb(proto_data: circle_pb2.CircleData) -> Circle: + """Convert protobuf message to Circle.""" + return Circle( + guid=proto_data.guid, + name=proto_data.name, + radius=proto_data.radius, + frame=frame_from_pb(proto_data.frame) + ) +``` diff --git a/docs/missing_compas_type.rst b/docs/missing_compas_type.rst deleted file mode 100644 index 658b73f..0000000 --- a/docs/missing_compas_type.rst +++ /dev/null @@ -1,79 +0,0 @@ -******************************************************************************** -Missing COMPAS Type? -******************************************************************************** - -.. note:: - - We're doing our best to add support for as many COMPAS types as possible. Is the type you'd like to send still missing? Helps us out by adding it yourself! - -This guide explains how to extend compas_pb with support for more COMPAS types. - -Creating New Serializers -======================== - - -1. Create a protobuf definition for the type you wish to add (for example ``Circle``) -------------------------------------------------------------------------------------- - -Create a protobuf definition for the new type you wish to add. This should be placed in ``IDL/compas_pb/generated/``. - -.. code-block:: protobuf - :caption: IDL/compas_pb/generated/custom_point.proto - - syntax = "proto3"; - - package compas_pb.data; - - import "compas_pb/generated/frame.proto"; - - message CircleData { - string guid = 1; - string name = 2; - float radius = 3; - FrameData frame = 4; - } - - -3. Generate the python code for the new type --------------------------------------------- - -Now run the following command to generate the python code: - -.. code-block:: bash - - invoke protobuf.generate-proto-classes -t python - -A new module called ``circle_pb2`` should now be available in ``compas_pb/generated/``. - -4. Create a (de)serializer for the new type -------------------------------------------- - -To create a (de)serializer for a custom type, use the ``@pb_serializer`` and ``@pb_deserializer`` decorators. These decorators will be used to register the serializer and deserializer with the plugin system. - -.. code-block:: python - :caption: compas_pb/conversions.py - - from compas_pb.data import pb_serializer - from compas_pb.data import pb_deserializer - from compas_pb.generated import circle_pb2 - - - @pb_serializer(Circle) - def my_circle_to_pb(obj: Circle) -> circle_pb2.CircleData: - """Convert Circle to protobuf message.""" - result = circle_pb2.CircleData() - result.guid = obj.guid - result.name = obj.name - result.radius = obj.radius - result.frame = frame_to_pb(obj.frame) - return result - - @pb_deserializer(circle_pb2.CircleData) - def my_circle_from_pb(proto_data: circle_pb2.CircleData) -> Circle: - """Convert protobuf message to Circle.""" - return Circle( - guid=proto_data.guid, - name=proto_data.name, - radius=proto_data.radius, - frame=frame_from_pb(proto_data.frame) - ) diff --git a/docs/protobuf.md b/docs/protobuf.md new file mode 100644 index 0000000..ad3d721 --- /dev/null +++ b/docs/protobuf.md @@ -0,0 +1,1295 @@ +# Protocol Documentation + + +## Table of Contents + +- [compas_pb/generated/arc.proto](#compas_pb_generated_arc-proto) + - [ArcData](#compas_pb-data-ArcData) + +- [compas_pb/generated/bezier.proto](#compas_pb_generated_bezier-proto) + - [BezierData](#compas_pb-data-BezierData) + +- [compas_pb/generated/box.proto](#compas_pb_generated_box-proto) + - [BoxData](#compas_pb-data-BoxData) + +- [compas_pb/generated/capsule.proto](#compas_pb_generated_capsule-proto) + - [CapsuleData](#compas_pb-data-CapsuleData) + +- [compas_pb/generated/circle.proto](#compas_pb_generated_circle-proto) + - [CircleData](#compas_pb-data-CircleData) + +- [compas_pb/generated/cone.proto](#compas_pb_generated_cone-proto) + - [ConeData](#compas_pb-data-ConeData) + +- [compas_pb/generated/cylinder.proto](#compas_pb_generated_cylinder-proto) + - [CylinderData](#compas_pb-data-CylinderData) + +- [compas_pb/generated/ellipse.proto](#compas_pb_generated_ellipse-proto) + - [EllipseData](#compas_pb-data-EllipseData) + +- [compas_pb/generated/frame.proto](#compas_pb_generated_frame-proto) + - [FrameData](#compas_pb-data-FrameData) + +- [compas_pb/generated/hyperbola.proto](#compas_pb_generated_hyperbola-proto) + - [HyperbolaData](#compas_pb-data-HyperbolaData) + +- [compas_pb/generated/line.proto](#compas_pb_generated_line-proto) + - [LineData](#compas_pb-data-LineData) + +- [compas_pb/generated/mesh.proto](#compas_pb_generated_mesh-proto) + - [FaceList](#compas_pb-data-FaceList) + - [MeshData](#compas_pb-data-MeshData) + +- [compas_pb/generated/message.proto](#compas_pb_generated_message-proto) + - [AnyData](#compas_pb-data-AnyData) + - [DictData](#compas_pb-data-DictData) + - [DictData.ItemsEntry](#compas_pb-data-DictData-ItemsEntry) + - [FallbackData](#compas_pb-data-FallbackData) + - [ListData](#compas_pb-data-ListData) + - [MessageData](#compas_pb-data-MessageData) + +- [compas_pb/generated/parabola.proto](#compas_pb_generated_parabola-proto) + - [ParabolaData](#compas_pb-data-ParabolaData) + +- [compas_pb/generated/plane.proto](#compas_pb_generated_plane-proto) + - [PlaneData](#compas_pb-data-PlaneData) + +- [compas_pb/generated/point.proto](#compas_pb_generated_point-proto) + - [PointData](#compas_pb-data-PointData) + +- [compas_pb/generated/pointcloud.proto](#compas_pb_generated_pointcloud-proto) + - [PointcloudData](#compas_pb-data-PointcloudData) + +- [compas_pb/generated/polygon.proto](#compas_pb_generated_polygon-proto) + - [PolygonData](#compas_pb-data-PolygonData) + +- [compas_pb/generated/polyhedron.proto](#compas_pb_generated_polyhedron-proto) + - [FaceData](#compas_pb-data-FaceData) + - [PolyhedronData](#compas_pb-data-PolyhedronData) + +- [compas_pb/generated/polyline.proto](#compas_pb_generated_polyline-proto) + - [PolylineData](#compas_pb-data-PolylineData) + +- [compas_pb/generated/projection.proto](#compas_pb_generated_projection-proto) + - [ProjectionData](#compas_pb-data-ProjectionData) + +- [compas_pb/generated/quaternion.proto](#compas_pb_generated_quaternion-proto) + - [QuaternionData](#compas_pb-data-QuaternionData) + +- [compas_pb/generated/reflection.proto](#compas_pb_generated_reflection-proto) + - [ReflectionData](#compas_pb-data-ReflectionData) + +- [compas_pb/generated/rotation.proto](#compas_pb_generated_rotation-proto) + - [RotationData](#compas_pb-data-RotationData) + +- [compas_pb/generated/scale.proto](#compas_pb_generated_scale-proto) + - [ScaleData](#compas_pb-data-ScaleData) + +- [compas_pb/generated/shear.proto](#compas_pb_generated_shear-proto) + - [ShearData](#compas_pb-data-ShearData) + +- [compas_pb/generated/sphere.proto](#compas_pb_generated_sphere-proto) + - [SphereData](#compas_pb-data-SphereData) + +- [compas_pb/generated/torus.proto](#compas_pb_generated_torus-proto) + - [TorusData](#compas_pb-data-TorusData) + +- [compas_pb/generated/transformation.proto](#compas_pb_generated_transformation-proto) + - [TransformationData](#compas_pb-data-TransformationData) + +- [compas_pb/generated/translation.proto](#compas_pb_generated_translation-proto) + - [TranslationData](#compas_pb-data-TranslationData) + +- [compas_pb/generated/vector.proto](#compas_pb_generated_vector-proto) + - [VectorData](#compas_pb-data-VectorData) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## compas_pb/generated/arc.proto + + + + + +### ArcData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| circle | [CircleData](#compas_pb-data-CircleData) | | | +| start_angle | [float](#float) | | | +| end_angle | [float](#float) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/bezier.proto + + + + + +### BezierData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| points | [PointData](#compas_pb-data-PointData) | repeated | control points | +| degree | [int32](#int32) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/box.proto + + + + + +### BoxData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | +| xsize | [float](#float) | | | +| ysize | [float](#float) | | | +| zsize | [float](#float) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/capsule.proto + + + + + +### CapsuleData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| radius | [float](#float) | | | +| height | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/circle.proto + + + + + +### CircleData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| radius | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/cone.proto + + + + + +### ConeData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| radius | [float](#float) | | | +| height | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/cylinder.proto + + + + + +### CylinderData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| radius | [float](#float) | | | +| height | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/ellipse.proto + + + + + +### EllipseData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| major | [float](#float) | | | +| minor | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/frame.proto + + + + + +### FrameData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| point | [PointData](#compas_pb-data-PointData) | | | +| xaxis | [VectorData](#compas_pb-data-VectorData) | | | +| yaxis | [VectorData](#compas_pb-data-VectorData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/hyperbola.proto + + + + + +### HyperbolaData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| major | [float](#float) | | | +| minor | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/line.proto + + + + + +### LineData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| start | [PointData](#compas_pb-data-PointData) | | | +| end | [PointData](#compas_pb-data-PointData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/mesh.proto + + + + + +### FaceList + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| indices | [uint32](#uint32) | repeated | | + + + + + + + + +### MeshData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | optional | | +| name | [string](#string) | optional | | +| vertices | [PointData](#compas_pb-data-PointData) | repeated | | +| faces | [FaceList](#compas_pb-data-FaceList) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/message.proto + + + + + +### AnyData +arbitrate container to hold message data and default data + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| message | [google.protobuf.Any](#google-protobuf-Any) | | | +| value | [google.protobuf.Value](#google-protobuf-Value) | | | +| fallback | [FallbackData](#compas_pb-data-FallbackData) | | | + + + + + + + + +### DictData +repeated serves as a dict in protobuf + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| items | [DictData.ItemsEntry](#compas_pb-data-DictData-ItemsEntry) | repeated | | + + + + + + + + +### DictData.ItemsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [AnyData](#compas_pb-data-AnyData) | | | + + + + + + + + +### FallbackData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [DictData](#compas_pb-data-DictData) | | | + + + + + + + + +### ListData +repeated serves as a list in protobuf + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| items | [AnyData](#compas_pb-data-AnyData) | repeated | | + + + + + + + + +### MessageData +root serialization element + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| data | [AnyData](#compas_pb-data-AnyData) | | | +| version | [string](#string) | optional | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/parabola.proto + + + + + +### ParabolaData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| focal | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/plane.proto + + + + + +### PlaneData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| point | [PointData](#compas_pb-data-PointData) | | | +| normal | [VectorData](#compas_pb-data-VectorData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/point.proto + + + + + +### PointData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | no inheritance, so Data will have to repeate but apparently | +| name | [string](#string) | | | +| x | [float](#float) | | | +| y | [float](#float) | | | +| z | [float](#float) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/pointcloud.proto + + + + + +### PointcloudData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| points | [PointData](#compas_pb-data-PointData) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/polygon.proto + + + + + +### PolygonData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| points | [PointData](#compas_pb-data-PointData) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/polyhedron.proto + + + + + +### FaceData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| vertex_indices | [int32](#int32) | repeated | indices into the vertices array | + + + + + + + + +### PolyhedronData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| vertices | [PointData](#compas_pb-data-PointData) | repeated | | +| faces | [FaceData](#compas_pb-data-FaceData) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/polyline.proto + + + + + +### PolylineData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| points | [PointData](#compas_pb-data-PointData) | repeated | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/projection.proto + + + + + +### ProjectionData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| matrix | [float](#float) | repeated | 4x4 matrix stored as flat array of 16 floats | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/quaternion.proto + + + + + +### QuaternionData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| w | [float](#float) | | | +| x | [float](#float) | | | +| y | [float](#float) | | | +| z | [float](#float) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/reflection.proto + + + + + +### ReflectionData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| matrix | [float](#float) | repeated | 4x4 matrix stored as flat array of 16 floats | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/rotation.proto + + + + + +### RotationData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| axis | [VectorData](#compas_pb-data-VectorData) | | | +| angle | [float](#float) | | | +| point | [PointData](#compas_pb-data-PointData) | | point of rotation (optional, default to origin) | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/scale.proto + + + + + +### ScaleData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| matrix | [float](#float) | repeated | 4x4 matrix stored as flat array of 16 floats | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/shear.proto + + + + + +### ShearData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| matrix | [float](#float) | repeated | 4x4 matrix stored as flat array of 16 floats | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/sphere.proto + + + + + +### SphereData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| radius | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/torus.proto + + + + + +### TorusData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| radius_axis | [float](#float) | | | +| radius_pipe | [float](#float) | | | +| frame | [FrameData](#compas_pb-data-FrameData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/transformation.proto + + + + + +### TransformationData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| matrix | [float](#float) | repeated | 4x4 matrix stored as flat array of 16 floats | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/translation.proto + + + + + +### TranslationData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| translation_vector | [VectorData](#compas_pb-data-VectorData) | | | + + + + + + + + + + + + + + + + +

Top

+ +## compas_pb/generated/vector.proto + + + + + +### VectorData + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| guid | [string](#string) | | | +| name | [string](#string) | | | +| x | [float](#float) | | | +| y | [float](#float) | | | +| z | [float](#float) | | | + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/mkdocs.yml b/mkdocs.yml index 461cf57..38e06f8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -122,10 +122,14 @@ nav: - Get Started: - Introduction: introduction.md - Installation: installation.md + - Examples: examples.md + - Missing COMPAS Type?: missing_compas_type.md - API Reference: - compas_pb: reference/compas_pb.md - compas_pb.core: reference/compas_pb.core.md - compas_pb.registry: reference/compas_pb.registry.md - compas_pb.conversions: reference/compas_pb.conversions.md + - Protobuf Definitions: protobuf.md - Other: - - changelog.md \ No newline at end of file + - changelog.md + - license.md \ No newline at end of file diff --git a/src/compas_pb/invocations.py b/src/compas_pb/invocations.py index 1995614..c74c1d3 100644 --- a/src/compas_pb/invocations.py +++ b/src/compas_pb/invocations.py @@ -192,20 +192,19 @@ def create_class_assets(ctx): def docs(ctx, doctest=False, rebuild=False, check_links=False): # intercepting the `invoke docs` call so that the protobuf docs are generated first # the single html file is linked to from the main docs site - from compas_invocations2.docs import docs - protoc_path, plugin_path = setup_protoc() proto_files = ctx.proto_folder / "*.proto" - target_dir = Path(ctx.base_folder) / "docs" / "_static" / "protobuf" + target_dir = Path(ctx.base_folder) / "docs" target_dir.mkdir(parents=True, exist_ok=True) cmd = f"{protoc_path} " cmd += f"--plugin=protoc-gen-doc={plugin_path} " cmd += " ".join(f"--proto_path={p}" for p in ctx.proto_include_paths) cmd += f" --doc_out={target_dir}" - cmd += f" --doc_opt=html,index.html {proto_files}" + cmd += f" --doc_opt=markdown,protobuf.md {proto_files}" print(f"Generating protobuf docs with command: {cmd}") ctx.run(cmd) - # now call the original docs task - docs(ctx, doctest, rebuild, check_links) + dist_dir = Path(ctx.base_folder) / "dist" + + ctx.run(f"mkdocs build -c -d {dist_dir} -t material") From 0ac97f74d890aec7ee415e365c55c731d0f08a41 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Mon, 8 Dec 2025 17:57:58 +0100 Subject: [PATCH 04/10] updated site-url --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 38e06f8..c678765 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,8 @@ site_name: COMPAS Protobuf -site_url: https://github.com/gramaziokohler/compas_pb +site_url: https://gramaziokohler.github.io/compas_pb/ repo_name: gramaziokohler -repo_url: https://github.com/gramaziokohler/compas_pb +repo_url: https://github.com/gramaziokohler/compas_pb/ copyright: Copyright © 2024 - 2025, ETH Zurich - Gramazio Kohler Research From b9a560c9c3845406fdc7a22331b0a56f7ae365d8 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Mon, 8 Dec 2025 18:54:18 +0100 Subject: [PATCH 05/10] mkdocs workflow --- .github/workflows/docs.yml | 33 +++++++++++++++++++++++++------ docs/assets/images/compas_pb.png | Bin 0 -> 26122 bytes mkdocs.yml | 2 +- requirements-dev.txt | 3 +++ 4 files changed, 31 insertions(+), 7 deletions(-) create mode 100644 docs/assets/images/compas_pb.png diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 189f7ef..3bc333c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,17 +4,38 @@ on: push: branches: - main - tags: - - 'v*' + pull_request: branches: - main +permissions: + contents: write + jobs: - docs: + deploy: runs-on: ubuntu-latest steps: - - uses: compas-dev/compas-actions.docs@v4 + - uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - doc_url: https://gramaziokohler.github.io/compas_pb + python-version: 3.x + + - name: Install dependencies + run: | + pip install -e .[dev] + + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + + - name: Generate Protobuf Docs + run: | + invoke docs + + - name: Deploy to GitHub Pages + run: | + mkdocs gh-deploy --force diff --git a/docs/assets/images/compas_pb.png b/docs/assets/images/compas_pb.png new file mode 100644 index 0000000000000000000000000000000000000000..fa39cc9218ab8eb40952630d1925d2225e578d26 GIT binary patch literal 26122 zcmb@u^NP_j`X5C|GAO*K6P0)>R11aeaN z<|duYIru~2s%iWHfuN!%{2&L${f`g`9)y;fvVm9f^0<%J(65)$2WuDX?0>1Xd^$nb z!E;+B8_BQY+5gk&?dilPdzbsaB?YZS#MGu~j-OqNYZ5;jlg3mLqw<+_p=$Q&ugxg7?wS#8Hoxc%ItXzZp5~=%VE9@bF5R{BzM)ab#$zG{{l@NooC(=VY(n z559Qvh=_0fpHQH* zBEh`&*_+OY2n!r%<9ZyyXhY6Zih(h&&|%jb&c>wTxYDiDuFk|qXp*s@BDC|d{dhJ+ ztiVQ+BCQq8AxXrSNM1~5<|}D!vp`1=yxkjQaS#@z_PZ5kkc1f~!sjdTDT}yI--8`k zMn%`pKh~58L-0Lwm=G^v>8Hhe5t^bLSaP22aj9j}K~wORlGW5Gu^*GMFb*kUrB*@E z$)*7j-vp9ljmxYKC><43vb#o&R3lBlKCWoI%*-Rn0*?}1ySAdE~$;l*gqF^*uL zwfQ6Yh^)wY22Q;h`uB;`7Cy1Q`LB%=_B%j9^k3T>Yxsl=9{$(!4Lqlpfvd{kPyuUik8p zh{eApo@+!a2~aHIR0!Sqpry%ZmpKNu{1kMBqP4og0Cq)Bm=7_GJx|z%GRR-AvARL; zHB!X-G3MkW*uR$5xTSQxTDhTB=wdLMl};6LJ;-QxBh4r?_&83#gSBnv~NTNJOlc)@IoWYCuuj?$O0A9+6ikewSu>D`1@8r1R` z51_#m2`f-O?(j#ZpMjP1UEj4Nn(}!PtFl>QiOJzqMHrhvFA7Y+H9w{SMtBl7$kbk~ z7>GsLxltqSWb+U8X<^DlP>sZ~H#gEur>&Odyn1nc?= zXQXdEo+}x1P1JEGHSGp3Y}lHxVPattEG0-ofmUk3f43ZT4a8==&%T}9`XGdOH%h6syWLs zq=r8Q$G%|k?YWNakxNISIrWr*uW0F<^WuH=zM4{5ksOj}#8>;e8sdSn67LU4TtE_j#jE}st&k&@1<(oMnTfl zUS2KxGp7dgCsyWy2wZ)9=2-++H(2*LoG&r#?pX0^D&Or311_f2hW&Cn6K4j#BYMMi z`NzCep6#B^C8)xMAu?V^*n~YSBY~!;S<=q;&|YwjD}S71Z6e{GfHoMn<|&X0#}Y2L zjFv0%3#($7sIcz#^{KlZ@nX)k5!P17QI#zk{$S62NMoVB>`yrP z5H~UOY4=ACaHt~g1bN^Yzj3DYoP}4`N?{9+c4IHn%Iom}lX0?_au7YZH{j3gbQg zfj>bJGeK9TL4|8+`$Yrt4~0}`g#$`2nXva&_{gffX=l)H22Ilg5s8CyV&XrT?yU~c zyQj(ifP3s~*9~s9CwWLUq-q z(CY?oD&GJzDq_F9SQ|T78!rp$q#%r1h*-jDm3_P)xADf1#(Y;d(bI(lB@{qoaY~!* zkmRI2HS#$lY{AZx2fLH?F85Ff`Smhw9~fQJkx1?${uO_Oev3bHkwF#V(NZ0-nC}kaEEHh^4?f5rhFENb z@BULc5m?iIP41jw2oyARdHvF57*R(*uy>;bp>ndIL}EPf2H&PcL{!@=EpPgvuS|E@ z@In(c@+N4=;&N~Y--Gs8<6XlD;mA-g+D7^vDkBC}OdDwHh1bGlt9L$6b10Z^U(eyx zKvQkVVPNOQOkoJBI}_q=6qw^yQ$h!-kF_5A1;k%mlE8-nS&BohXH=mAny z3<@fn6@XeHfBBUprbDgaoU)_M}yIVW@@m5QeLMoejMA5l4iytpxfFJyo~}N zSk9uOm)x+HCVwP@HMzJ9K|vq<;+efzRJ!WI`(IxSZ(|y`c#I)Vq!+A%Lpk}v4iyWF zDh3JhE^j`e;mb?K8?X)JzXKp`LtF9WA7=L`Oq~EzfJiY&^KXh^m;zz~VTwkNC5GBf z4eaJ>fzs61m1Sm4uv+RMUZoD0DbNsi(hVl3J|uCE;Z@2es1JWbNQVC@!GB9~kK$Fj z{crj44jjsa9l1yFDha`}jjKurD_4wnh3-_98jG zBP<^MnvRCZBahbR1bkn-Di-FqZe-W9S0cEG`_ChT3oq27ikDif$%|E^cY{YP`3?jl zv8W(%Vse6!yFEMy22(mi zWD*y`FpMw}W*j*(!liuR6lsvE#?W-OX8K11+w|{0b-3j6{<1g)d)9k}_h@w0O=ka^ zQ5;_wMgSfQqKP>&jhFqCokyGg*!7Bhtxwl1*Lg<}?D=WysuS{O_U$t1|B5M4K!R8R z;}IaSOynGN*prZ0waL6u*%;u!2`h~sv~=k`rF8Jz-gUz4^o~`g@IMuJ+K5IA4P!}) zM-v*ZVU^2QyiGJ$MhJU)a~uL2l?>~`@xO`~2$5zhqi(eUWw!Ae#XitJcKg%yhK((R z0G|n;QKvuh*}rw8$-*!ef5WYp+KN_G_hmzzH^W9HkLxn?xHFN!=igm{jsq%HC*%aC z+%paTDeOTby6;kUHJ*OGKVSeNi=FS>4e)uh$6r&SWj>g9E`5Ul?b9VGv*~ht(>qi5 ztyoO@iXzj-W$U}6VtrI$n5*BHaKebO{2c+(TYnvGA~;%pg8=jd_C1}m+^L`2$Vw1x;Ic^lU{ z0HC++fW$X^nBtKi%O(|p{cAqd7K7Cu2}3p6D2GdFT(sVOWbKor0RsI9k?oj z{w0EE)c!j(AP&jPhMWBjb~sy?rT~XGRl=bRT(=r9Bx;6Ce=b`;5g8J*IzYqDcpeH# zUdB`OnBK}!c)XBx;ck^Qhw?p|rm_IcuIFbog_i+$+q_7>nALYeZ<&g6Z99KY2E(zt zN zVRV9RUQ}2%8t{S&ZVagR1|7!C-QaF1SDU2NWYj>vevR+*wjR-?z)*lIr9&C*CJ8O! z3ViR01kU@Ra!cnJ8~rp$QukhHw@wBnrt0YXQJX{L>JAh};82WTLx zbHB-YNJIQhWA<7LNTApe!v{jzFRwrJ)A_8;wE1hzw0`IFn&|#Fl_4^%Q1fl1o#$+4z*MbRrfVg6^m}&$koZ<*Rrk`LcR%IS&)%u+dH}?_5}B{-H_cNwKGl* zztIqPe$J5N^jETe;Xt3K%cGO!*C#{&{4Raod%O1(2Al>dB6xk-s1XsDnQHlwq3HYs z!#%2+FIZNJGDV8{)4P|?QBzl)UeUf~f911EyLnO5#*odBMn7l&WO>aKQN(?n%XM_J zV|uh}DVrfnt#D5Fk@3oEpycCHWbwmPfa_##q{Q$22y39UAomwsr47hXq$s{g9&t)$ zu47NJ#)wbz`Ts!YA+r8ZaF=_>3Z8xU5_Bwgsg%aNi3>?sA@qUbueZ}1!ZU&)QIt!=E;dcV&N!)89=O?zK$is^MZ zX0t^hMCoXd+OEV$p6tuq^nJ1!AW_&F^ZZeS856(DDwU-|XoT1SFXM(Zupj!JCff_Y z2Y(DakTF#${s)5Drr&c!r$iWyPiklQU$P;e*Xo>Z-Qb)0(-5)B4`F+Z4|i*Cr$8mm zn+h1mIq<+I3~|&3p0t&N{6>b4VGrOtP8iUafWJyKN8I+O0G!(xZ`pibm0s>*Km;fS z1TmY5nhUH&7S$c@|0cO|C5DQu9!ZVm!=&5ZS!Rx~+*_PmuT|v!pV%JDzVD02L~`f`5Hs=Q-|C$m?FB?ztl2Y~ZNM-@ENynG!edC@XsX5|b73lb#8s+I{_S zut@VBwRUT#{uKF)!07)WUEYk&x#9S}3k!z0G5w?koT}JPFQ1WNu2%QA6nzY^gDDRA zNO_7kA@wp(D)2_F)d4}EVMZR-QWchUI%T`(ylr_@mC^_NETUvre|OEaelwGG)ipgf zx4w`Ui<=wbN8CxvYW9HBq`1T14lMsk9n@T-n6`@I<=KGrt;=thg#${iH>k6G zV6XS3bgD^7^u|hXHJwc$Psu%}?MfeQhs-wfj zQiD7v@8$yFKX+Gpec^C@wSVrz)%PJtf_dVqn8*(Z##EiZccXn?7sY~7a}7bU;EdTc z&_Ydrp>USvsllIJsZHuDi?Rs!cSGd%1)=palxr!!YB!V8ybO=-hVm-$j)!1aDy1Vf z0v_JCcboYSx12JhgdSDAnC4zh7{u7W%VD0*`f9C zu8AkNs}fid;=VZq&Io-dj(8Z zX!5b6T$a809`qU7n|^Gnj|)Vc{d}1C3T);iN6Y@`up=<@YO2@4F;V!4z7}R@{c0KL z*xd3dHG4zgD14aeqJBWFk8oe?W;nr2JkHVos8QQk3?A+SiWYXw{+;Ng8j=^=nlb;LgdwqT34^^MSQYz!DSWt>@Jee6ATkCpnGN^b2xytqphY6$f zrGz%`nOEi4G;jM)4L$@uAmVGG@;zrwyRkHjpbyT@jW7(e~*+pq(^P5MT4>UCP z1e9D_0Gc%@>r)w)RjXu(lPXBe=lgFs$%J!WQipoK%03Dx)3ZOQOn^8ZPLkgz`6J_NLAP2><;**UuR`64S554rgp9?UwhxWEOU6ZUH;UJi74q;PhT> zo#2$(xV<*sE%tU44P{sIzWzd`^wE%MUu{Wd-Kxu&`rU#XkJN3vyPr%gM(&oZ7THoG zy*=&Y7$7ph`I65+y#MY@D7$W&{bzZH!xggd7IEa6BS(N>Ie z&ZyH3oXy#`2C1!9eB{Geu5R`#Q$-W$2jW=DA?}ddbF|ar`u^i@9vQQvSAx~4PEkP) zw0W1VH8c9axx+aqe+^Gss1*o-k5m}hdTS7t$i|s zmD*~Bcsq9)B#UP3z%DPz*}9K=-qbwY5x)B*Er0bWqT$jrUZsh;$PVMJEbRKLG7;m ziP$02DaAd~hJB%&uCw&``y05v?0VnNetR7(gm7bJmqbQ{_YiWejliNPD2EK+f{52w zb&eFOPXfH@ul6_rjIM2anqfn_rPA`MP`&)c2GbRJIVdz4He-mepaps4sl; z<+EON*Y;P$0g|1ZUt&?_IGD*f;j*wihx4)YJv0P_aEQ`<5S^2aEHS0={t1a%h)yB9 zg;(3L9=&dZMW4ipUqnl{#1Ks)j`>2ugn_aCKvr(8HyqA6tC!hT$Gdh?S;lW;^;8l) z@qoG?vy|c0t|ErKBKm4WrI67CMSOoWjEFhit0{M|pKkT2MGkUoP}eA{mSY*kicWo% zfE<*jJF(m6VV|sBDm!hw#B%VnhRua>{bOqZxZp;HOIi2d^{7P&GVu<4#|(SUZ9v2# zK#YlXG}pyL>DtZPHq^*lp5Et*4}Z|b@Latn6Vmv}Gb@It;$vyN>;u)y+|>|A`VUrj zJ$4J&5kVJ5^XJA*={UE4c&Th(r~Vb)UL&(O!pDNj=b116P$WWnNJ9TrBFLz@%SK5X zO-RTuU3@UDSk6Tk5ZU-O>jW^fZ$5|bE7SJ7PyJ09cSH;O7liXRUVcTEW=kvqkMljS zFX>K*&i~e+{iv>Jt?vRbnw00>Bn0=$%9eR~J~G4Mk)yZ!pi5u&flOG_@rL0xYvr52 zsKc%s*@6N90vou=M5f@!4H~0gX#N8*6L7Dd{<0aaF@`+FhzfIEs`syd0G=COwxoPi zfK&UIu!aDcBbyv3&9>GoRyg+d;AEKnmbEfuQ|FwiY`3&7I{)+@RQtrH%s~J|K3$>m zS1W0`hyZ~SY7hWN6&$ua){ftmd)%12(wvF_mm0Nos+ZEQJ7o{Iclsz`;!6yk7<<(9 zW^bguMpSmu5K1MXEGXg`@|jFXuw42b#ZASnysTJmF|xaI$nWFpTKtf?*2l1PR#BNi zj3#Ml!`XvAijYxRZJ`^#(_U&*M^Em_iWj~T3?c>>d6DXK+{Q{$XkDS>z${Q#lC_lk zEkg@mg+!k-A<|88IKbY%-U$)ln2bE!q)wZjKrEAGJfudt*FBI%TK?2HBvH>@T9rz1 z6psArVtM)=af$pzZh(VN{xN;?E`GlcaZ=ui&vk+jeLFw0$cJx0nPIO@9b4#l6tkES zcdUd%sqV8wWFk4_!mTU5@OJJEUr{+E0a{8NgXJrX4$jMrP9fRl?4=4Y|BtEx<|Tl2 zF^ek2F}AC7(g9jg7RRi}({MC*iE*3canslR=v(4TN{wQz8-I5x9}L=SvTvKeEn)|6 z``v$6gfHcaisi_1)r{dqKoJte4*A8TERUXmpD81xk6m>cYHXxuT$I$4{eVhggj4Z11Ci%^MSMJ z?04+k)W1AZvmvR^?oFQcg@+0Ux(LIgycTpC8b)AsYP95vNu)fYXPrx91?m2oo&s}wYibakTFi=RqyytI- z$uS2y*B;0ay+8Bi*0`lm6c_3Rk5<&zjKFGBK9+zl?R2daJ=J{H$Y20XzB`Ja)N?xrsax&GWd+oh}*Rx0eJ*j~! zfYOZqPzT+K|1Gx>T#~O9I#F6KB(H)F0h2=cRX`U!Bys3@sU0c-zMyM<3F~yNd0udK zuA3uJHmkToXPNKMQAcmBQr%I4!_DzXyXGP zJOkXv{ww#LC%l-!`7yD^gf&7N)fOr0e1V^yBYph=rr1mwM;tRaO9Wd9*mcKiW?lK ze{(^mo((D~7+3PZXKQ?}-a??rVM|L?A>G*6J=3Y81H(PtdqmCDw>O>)VPzMSwqSo- zr(Tc(y2_~|VF`%Bq8^j)Pb*ea;4)rM)w-Qd=3firZy?@TJ_@lo0lKLYEkq}WMF!37 zXkEyE4B)8Rje20yO?tuI+@ zz87;Ks0xQ-yT>PXpa^2nT5gf|3S+OjH2cI-63YIPiK7Y41m%MQ@AU>d11NjTIk8T4 z*$f0jkUd%p3%B(MAVo-WK-V*cA}20^^uGl0Vxrc@bo%`Rn@wDaB|fztZ?KbsCyzCq zbG3($FpxTYJY#089pu&~_L3E9<_v~R`cL5Dd^oxxzVL;QqoFu@|Hq zVoz2DVCKaZA48$p?JJ%gg-3KRxuCEQNnL%hJURXi^;vT$Hzl^9m4+Eijla;fCU(GF z9x#`Awg!<$%g55ubV7;`|1j&hA+B?P1=abzs&w=|LAek-SD@UCf{z3Z%DD&^4|?i5 ziP*?AG|*+1jf^sjNjaWyHNo72OBwiISo`q?H9vS_5z1cdOom7FZQ;C_9K|<=Ob>`l z3SnEEWzxk)08>()hz zLcS#wO|h~3?)k^ykE5pye`JBknf%8wypUygpCbxh2eE+h2_T>VIqK4R=~f$RRC3%8 zU;Fl>Yj-l`m*giA9g$NVLQ|6)WFe0Goi&yomF1IsAZlY9j{wjRdVm|KG2QV=7sPy5 z;)1%#9f^U~l~VOnmqG33wpFT@dXa1-YVLdL^?WiF3>g zf7ZeromqppQ!#6k3Tm0Tm%bpoPgaz^fC_IrNasEjFwMUIbZfSF|L1F9<0}7p!=F_0 z)Ea^1ZJoKu+Ic)7JeqCz)X_=X*;s$GwDMJ!Y6lK=v_HEoTJ@cY7_p4c&zmKSef65`wiTA2LHvT)`ws3k z4sz!P!OF>zrBfW|e1i9W`fh!i7^-j#&>jXBa(`#~k)GwG?45I^0h=O00Wzd(4LCNs zBFn`?RwhHH-AG~oA}!DF*Cl)yadS@lDwdTGuFZ>`+hRJ#!uBPUxA7;v6S;QcA9jW~ zY&69>)|dI{2cC*N^!y{s79hs;8-M0?P&-tvgD%V&e@fTabg!z#n69|=$~w<^C|i5? z$0-CTs0K^Gm62-;0p~dhKTh~P7jiCH8a2MW*i79w8fepUON_98&Fk|U?~TstnsLV_ z($mn)6?(btTy|Ib_D$F#xo)|waPbN?1r#gAOVlnSr>jXp*^0;Gs1EyZj*-|;dxv=T z_$!vpe`sH$ovV^JmtH;%HDuB-JemOYeIs}6Y4{D=m>Yi7-D5I+(d=aEsRk1hxH%?W zvDUy>C*ZAnm&){y5moS7Di1fDQC_DV zS}*j8wSDaK^^twaCk?bAc-plFFY@icKnOq&Ur6$e=poa@Dkq;tic&>NxQx@0B5923 zako5hmBK|-2n0H>F!c7q61l&xN~e!Z!}XBmR4nH}{dtPwja{q-fIK{qQ>dFnUjywg z{&{5UwY)spib8x~w~UM4j@7>AM{UlUlp5Xkl?v)T^l&lYOyB1ijOKf0C$aj_YaVZk zcke4c;w}x?sVtrx^(^Sy>=`Fs#xbogunY-l8RxGCc&^+xs8|m!e2-+knxAs<<|BqQ zu5SEqal2}cyjW|v9KbXOud?Q^(3UR6P2x#*877I6k7#QROZ*{}#3=BJ zrxD1H=iM&;CANl)gOk-C4w_0v#<#PV#-)yg^J1-FsKIPl*o5Kaaa{GC$@=5pUZ(`x zj&(O%{xGoNkD&D>a`^0Atx)%TvW@>>&6-Ntnz5P)x8rIqZEIa#k?omUd)?~ET z@}KPWt$h-Q)NNfiD}J5@8vLwaW^aQ~VJh>5n?k!hE6bseI(_#)Ri)|~O)x(iDP+97 z%It9LHn2lguk|lwaMQwJKR^B+vB3EB*;AM989U1e#RmI%adCu>NQH)qN%5MQ##(te zHH_@4xn1R=(&%4zRt>HmxIdFB`ZYRg?srqe18!e-#lB@f8lBCq8AyL#gd7kB?em}3 zIO*_Q1=8!%)JV26`;XJro~H*^-+Z49QzSz?XX5AVS3)1{$)GOo@cJrS$a5hiajB0S z%=ezGsvlP0x*F;?ujFOvqv3h`Yu0GjOxemIIdQ(o@0`iOD6!7=O=JEW+`%~-B4iGo z{;Fprg_#<+t&Git{Z~{UWSrlWP6_ns$LcNp1l=RFB@P{aOlF|Wstd48e%7($BeggK zhu+Yb`sCRvvka7eIurt)Wccfg^Rzq$6Cnr^(6Bm4!_GhiQzwq=_J5O=z{I~4eLJpx z%J~j=*iN&Y-A$2sx5G5i&osBcshwJ5j~)HSLQL5$QbjO}y`s8WG9dFp}m~MC2 z(nRjM^HJJJSbapc=)$h1uqXsAw}F5MbZXNu&Vs^JrF%9>2*14#)=9DYGDq zfa@l#?8r|iA#+Dm_|aa^Li!+3M)BbJ+i?FtS0^HqRIf{2ot6opQm$gvmfI3h@4t4< z{Be?Y&);*RMLg$|LOqRN*TUGrg0d9VJwaVMLR5$!E(Zs6)Gt-fw=loz+nF(SWuyuB zX&Tqs6`0q7VA}j)Td#xl^~A^5>z=D?#I*de4YcIxmFkT|=XD?!Q59B@xE;YC@8EI& zp1q)ZKdat=ldPPL{d8gPz39uEL@r>_Ra_#$W%u}wOoi!kbVW(BAZzxB` z_MC<0%@2-h=<=NAJ?oL%g%axt4>XCAq{!2&>0AxB1vzr=G~;^V-qFS=-gxU^;b~gL2 zw-oDG0}fAR-9yF!wN2O7yNMoA;{5 zk4TqXxT5o7I2zME!6UUQAL(?1M#kro1p-$rZ}#ORThOmE_03Nh3K%!@Zq?P>ce2`C zuX05KWLbAAs9o)7W_~qwYLaDz+31|<{_#e;wu?J2G{ZJXz8P(&N$DQ-m~Ysu6ka&W zyZkzSMuPjMWi#&836a$E^befRYgp1<+IWaj+qrrXY4Bv5%C5lYT?ZFL4p9^4dKCUg zLWEb;zR`G{L&YM090^UQtIcPXeZxDw<{L8_E~$;>%sY-;2pc%ol6y-ONApe(#-&Ox zgdrYtT=1grd+FzJMl$8~$dZB5~XU^}u{ivDbe*9UEv?&wQm6dlc zJESEK4c`pV;tTz63}Jjm4BmbWe@$v9M~!?6IB&>_tR6h5v6%d~S@M~GF+_Q(tcc&h zJo`6B>vE0f>1>Lpw{G@wM!M~P8?XrY(L}24W34#6n)hsn>(c=!-tU5o%{*2p7;ip{ zu`g+q+-9V1+=U{X}$sLB!iaKx_yl%i^ZY)=s|6@{hPlchjsGdl7 z|AhH2Rc48R5`8NQGym7(UhFjc`x^Oa%`e@xR_{lPq*&w}uslZ*#*o91DRm??r_|p7 z>zY0_NxtT|wpglW#r^8X>#P3+oKU-}w zlTmq1rJbjgPMir5j z6WfjES^Nw>)H)h-ivscac694XW$TEY&*~HAKf|0&0F|{_o7&CzffP^M2uE(aUcsES z;9IL-%d5A0f>>A5;`$x%z-UYnzkFP*$HIC~nm&<8lkM=DKLgJ!+G7{%7IbiATjrrW1U((w&I>y6yg~4N2 zUW%e`9*LN*p<5q2?lPtmBmvItrnBO>grLL(7tzyLUZtSUHb90-YHl#yxHd8k;=}{P zT2A|zO0L*|H=EzhJw~_sjrEVpB;bxLU#UQRGzKhDeCy=YiwQR5#Yy*w$|d}>KcZE$ zq1bUYlI*C?HX=cepIOX6Ztb+v*^ncvc`e~XNyN#T1%JJvRj=-)9*e8Bv-rEF>(ws! z7Siex-(k&F&OX*K1Vyu96h0c$`9;l-Wd%I_hnht_#W))x$>h;eah%4H{2lO81>xNh z@XZT+xAmB8nm#pBlGx~wZ{WS!TK#Ujh#?Yb^|^WGc^BW0V^UTS6vhEa0(b&Y*6hL> zCv%h#FW_79c=zXHclE*X-CHi#qz@78%yza)?b{6rYj_cyvibYD6P8S}*S>}%{LtMU zrIoN(b1wQtGC&Jf%g6i*0fHDuKiaLUq*V|lfT!fAa@wr%Kjy-BHx8KYefMDk|Gs!W zA6QP(V0tEqlVFCYym|BCV(QcNwi7Z2+(8i+1WJjs#cJ}zJjOgn28aY78Oha&uQr6c z?f0uU{94f!t@gLt9U>o1((S3V`c8FNboij88V|ZgU`NeGT8nTgl>TF*F;dMtzLP$= z-o0M9C_zo}sHV&9V##Ve#fbTzD_L~K+0_BdzGQc+#9AG|o+yUy;&lQesu_mJ$q}C? zh6`z}x+2U7j;8axI)XD6o8%-Pe~o_%NZ9h?bV)#d17E+Z2WT_whOZ;TXdNr2fw+&nRMrEi(W zW_F^?sOJ4Ka5Iv`^Tetcfwzk$LmE7#<)i#AbkUd+TD5OsH14+842BTD!!<2AWLnYn zhFPl8SxUqkb|Ie{70pF(+pUg4YKsw+2#l0H<`n<^tb40hT7ip#h}|o%H-KJH;IWoY zR5MCC3=n&kc8Ki}bENa60fGWE=au=+>wP=~E*?xX@EHMGajHQ-AnjeQ>1}**pfgY} zrb9)?%Zpl_wH_LUhxkv4^qO1{NP&8~G9J%UAdSxw@Y$^sDmh*yxxkBXKM&gj)^~An zhfk$%W+Bu_+=(TdY>_(Pyub_%lFvyHI!ilx4rz%J%}XFeUNF7+lR6*nk^j7J=sDd- zBkYtB?^!lYIhdiDSymXMDa@BR<^B--C;M*7@f~mT1yKYw`+R#(_7(aw85~6}O(bKa0%D{@)>McA#++x0^r6j#9{gZ&b0C!_D9I6&)?k3qtaGoyR8)Nin z32oEjcV}H80%v*>*7E332B^~q?R~z2au%S7bkG69b6%{f7Q7bX{i7+&dH3ffV|>nc zS;Qwc%f3JQiG&~oQ2re=4HB_>Oq^#H`@=yTv@FXHNf*nEgV??{I&#>1XPa+t!;M%` z;TVs}MbB>0veq&p2&U z{2%-qeq^wE^0eCU72W2#dH>PUFWml7m)k2BZ@H9D>y#5x22%elcC6+d<>!hWxzmqE zd8COjkJkJOY7kZBLXeOtc{&-TWadr$u`c?=7!O0Bj`(ut95Js>#{ z&WhWyJBLDTrl0_&I7BGRLa<15k`JV<$*19x>WcXr)fP8mw=-HQXtppcdcUXuF!5!0^Ts4EO!iY zBW>G#7toGs&y?Hs5&Q{A0I;BCqdAk{@LD-h?;w(ZO(oM=pi7nRvp!$3>~&8QzG4mf1M^njrP;iWX&y&CH1{8I3MgyT{u0Ty=sI(~V4@uO{) z+>;4F1YP7maL8H-;-kV=0H@g~?}`^zWJ_WmY|3ONoJi`i4fYs|Tn)#DEd>z85YA=~ zX_D&4`F627(_+#A80anZHMQZ&Mc_S|Ur5Afwm))SxxB|R2`S-oKPO9Q>0-yK@6Q{J zd*CM%e}(y6U(|UF^aQdLTA96~OT*{63!O08zWm=U#?n81JvKz3w0<(LQ_8oLv{K4{ zUtq06sNW$Kup#femN^uO`FZt^t2q|Nl6{n1TeH^Z1qaw6_VjNJH6U(D4|Jw(YtOK%zv&JxJwNIzEK+@CvI#EvWvNuXmpAVYZsmClU6b80 zkk{9lJ4&}D*S2@h8wm|8hVBk|f=bza_ec6za}CTT<|>3Obid$PQx)p3S=$h|5mO3) z{Hym$Z`5@AA`6NU2-;xg!@{BJvGM_%zvPOx708v`FZOA_74z;xl5#J_kzo5}+BofD zXZsI8;ocZMWT^asrSq_d2f5?`O76^mF=;z%c8}O?iJ^#RZ-ZjtHid`z zOWziyQ){y)PY*8VMh;Ow+bS?oSDnI8XFqpqSCf<=KKXOf-9T@>j9)d4Xe8kDz$0{IrmfFzO3_V3bGsjgahV$Zd}W&0 z=P+AO>>q%2S3jirIFQ7Z)himDU3=JhYaj_=5M&=B`$jn8rq5}UkKXXhoxS_BIB+#a zy&ZrdOB@|mv+whuQh&qMK~7c7F#;`wOvt+BzlbH&6@F~JUb@BBs*Wam zxO@e2z5#Rf&dREhE(Vccqyo{!M_tF7mEY7=uO%{#MuRrMz$K&n3I# z3p-K}oZz<9fh51K)<`QGC7(%ANV64=WOykyHTjV?Wixu*8woM^GUuy7W8K;3T8egl z#o7{@fa?flBlHFr(HVd$L@ z==v_mlkwAZRe$fu`FuiZB~)+Yhk2Cu|==fz8M<{lQt z$)};nlqpta+L%k<@)YC$Y0oPDe4nPk9bKe=(-pHr>o?CwvQ}A8?q_`8=GxN5erdYk zJ@AOwt(3;E=hJMQaf#9={pUtnn5|!s4(PF0X;E}+@SN5oRH>Kx+w~D* z4B-4LkIWZe*5g;QoG*|rja@umNLC<`C&fgH`3B*Q*T6jTnp2BMB?7XZ5Or3o-zg_> zTxvnm7^>^z?Z#!fEz{QCHQJm0k|T*L5wZqoEX$(_7u-l0OX6E0f0bUCj@sOM0L0 zj{k-ZnPcQ}8;oh7UYo5!2OUDl6KMAQ77{7AiNO}L9@>J%t36%ys{4@g!9Ys>f9?XH zI*+a;Y%p4V8)iuK)yp9BrMKd%qxsBx-b+o>2lsA)Z05>9Obb;f#AWNY6PIIcbSP%5g3pbXr^M!6}ZEaLACp7#m%I_kC^ z=()TBmCvW0QtoMs{OF&FL|fPH#&IGbn$lh1T;J&K$TTz0Y=yVswSNArMVQC!N9%jY z@-QLnuBw?SIA#{Ze<#@06~^CIA0faScjYXmhzq= z_s4RJ60P~uaD*MVI|dDJeA;LFV(O{pfF{tVvm*v~cAQKMSi${JNfWUlAQ=#^RKgQ? zH)9HT4S|P4x2t7g7p~i5jAr>3xD6>7v~JDu@n(_QIpBYcK>|(ufzEMAJg_invoq~x zY!h7bjT=N2H_o5DlWB^dC+4+By!=X~B|_NBJ>y#5v;p9qf@?k>L?gh~i@~S%m(=jz zm$;Y44*V>B_F?)r_Es3z6*_<^Lelry09`8~9a42Ph&RSUCaRhxOM3&V)_hOr@0y|; z@}5>s7=}PeNF4vVMbDq}rDK%Vu^rg(t=SXG10?|DRl-mubbT+N>MbxkZ}q_-fhfvK zDNJ9J8^Ml@hJV8lp{=8q@!I(DA`wW`4eFWarXzL0RG~sb7e?_t==KSyTG{jz(4>ZFkGTMEFzB#<`@S=wUI z>l|Z26_Oz6q>)^czERPb6HQP6jlU_@%sf=EUe5fR_s=h(_?uECKVn1wrQ`Rc{2Kj{ zPgmOmov%of9qV+Z{6SrH|L~3!>J_}g`YCs{r;@fi^f32ZXTA}FP-#+Joh%XiE>`>? zHR$V|U|tRGcTvT+EE^&HRv{w7bpLoieRj6`;KVCP6#`u1@pCq=-?~@)^iw9OF7{2VqSa0yBwFUa z3aV5f+u@3WQN=bfJ5n?VMu9p8b!BVEb%Tg}>2yO%A2#J>zim$QSe|1yM)DL;+g4`& z71N(lXP<;w&3(0TM!2`DD>)MGoqz$1`&;b@KFlgEqHFawGv+ul;%<4BQv-aN=A%B? zE(16OMiYE2__l3vVxwySM{^WZ^a$0a)K}5@kXbIVRC0lL1ejls(xyFlKNoX;5b+jR zXUPLCir)eHM>jO2P$uvSJxM5F!yj9Li?#yY7B5C5f~qS0k@EQ>$8K`nJirY$Kmme~ ziyrEjH(dUKH;s*~!B0XRt{{@PG5zS`&MADH_6;bMNm}}sj`#=0B(yy#WP~@Vsi${L z@0WP58o`4@kdPaw#}chDASZvSDZPi25{L9WOR3^tAg5r+B<6eRPeL19d`LtQ_bmqB z=_znzqQNj zch;Lchp1R%n>Xr=fjJfIC{Ll?LuJV0RKjVvgyX}ZNNr|nEaFJ)hS5b*i*~HEP6l`i zfNw}tFm{C#q${Zyz$L$*Gb0piCsaSa61(J=(V(ALntOz-QdcnuIyG{DEm=x$p%uhcGt4rN^1LyN-`JTK@C3a6ND@dnkeDYiNmkY`W{(H<_ zT|4d5spKJfOWrFvw7?9YY$PfC|GN9?hbX?N{n@1!sii@YvS?5Q0cnsDkq|*@5hRpS zDe0vx5vFu zuy7>R?lVy(L6@AuGA@&L)}y`&t^{X#I37 zoubKYYDHNBX&gSegb&3Cctcr?e?VM7k37iJ-CoV~<^{1aJ%At(^DniIRyhxI9k@sm z=ZKlhn(}T=+CnV5>e^{L(8@@U@xPgilKv_%N2(jKoX4T12-01$zcR09UO;X(I#;T_ zqmxlXiu#f{i8?D;?kC2ThJpm%hxof#{LDLh^CKA&XyyLDD%Ec5b5pxE(!ajI^2)Uo z5VrF!T*hIO)p%64$d?9v1NN;9RFO z1Co6RqWlj2&3(RKE#>shiQ z01_gLrF-=Dlvrsa#a@=w@sEJDL-Xukm?;?jUPkd=um-$MU;tV4VuoRXi-3HzKH%&t)}grVOuO=+%Rv_+ zek^`9;je!v=I5NAJb9@GE(zar5C_%y!go74)C1w@H1L?}Gk7xF;1l@C8ITdcg^Ow) zN`f!rBP6#L!#S9bJCouApV@XD+{4`5`@gv()0wFrbjU$up z3KH)oufT~Y2h@X$*BHR~mc5|R`<3|pE(TY4(ztxk!RI|cQbFt?yfx~2J$9%41{MUq zAgsHx?ru((LQFk^E6O;NcBW9$>y3f(g(Tc!c#KFQ8)8us2K=)uv&R~Q(iH$ve7nmw zH#zr*EkIlD3!deJThaL*!XfQ=&qzJk2d6a`M)^T{c3|4immhJfeR!@2mx<-}xA>#! z_K6Ga^223hJ9r$C&1A}}q3UvuvQNtQgV?98=9C;fv>iJdyQ9 zY8d6}n5Y;B7HCK1IV1`W{XL!~e{s536k#^n&~t5Zi}#*+>55Mh2i}40w|DKoy_?#8 z2h&8EfO#Icf9G?>D1cVfkvx|bAPrx+I~e7orz=2Aw&O99(P1&#o4+6k$ch$`r)b0guz)h^WD(?e=#FN(sucJZmQFg!=X4!sNs)3)l_OCb^ti5kF5J0N3ZhidDcb2v%q@(FI1E~jBV8Ghu1Gq-QXJy3z@<&pY zp(KrrKV-4)d|>g*GK0> ztH`kzFvH4B);MGWU%84(*WQsaE%4YtOU-hy4#cO6BjB%Sj;QfG~jCA;8{!PNi-G z1(xOe9mre_JYta?`fK9^yaPTw{zo6j0>HF2>AVFRa1k+SW z!J0qZIC;VjQHSwh(O{iP;RYdyI?gMiw?>kLui`&f;gc4kNF!=p;E}ERy*(|-$P^Mj zO|vZr1^~Y8c-5867Y1pKq()4f5TAe{_!q?ZxLx0vI27Kk*A(g}8MHa1Y4`B2I+%&D zZju~QT@En3PJkVb6O1kq1<*%|ii3J6g@o9S{}b_{1%< z1U4BIJSPwD{`+qv_2z9=yk8VMRD8piLGc94Jd2oRVSwjNqXrK*VXNAH0s>sb$~hIN zD^@Ui2tcXb0F<18h^_$oGdmz6rKvb5$gjGBW|(+Pdew-9u>|m}ldl6jL^2RHsov5= zzX53S0wA>)0?cG>g%G<4Fxd~m%j9V(1OBr0&jzWWyv6-crd)`V7B~?@B;YrkAtDnh zgeDYHNZjJ{{51u_pd?^OTr`hjBhdQ!PH+GZ;%Y68&R?q|BC#WnCcL^tNgz#-sLJOD zC$h>@jxbjoTp9wQID^@PGCFElOBKauX~H{0u8=YSFiBoSSk<$^lYz(T$H~F+iSJSw zApQX&|2WC{uO_rYZp7jce;0lo;PCUoa*%%$T;_ZjH1xDfbcJC6w86L9Ki1(wMEgBo zj<@%GDJ}iMw!n%U8U^5m(E^w5Z57C{PNM?E5NL#_(&ZlXgVaLHA&0ni4PGFX;f^=w@Ih+Lu1Aw}ZyymY*H zfEZa@(E(pa`hh0aR`uO!Ch-Y|iA065InlqDwcQFv0Np~+Kav5+BPMf;mkUYi5l8j* zB5+VXCGhqHQHwxEfgE~Ex}^!}or#eTnp(IEm%PxjT%?0jiiiOW77Zw`LP*jcu~3Zq zrwU1WZKmHUI20`kR4D@tK&QbVIhZOOXy9BQz96%@Pn=NK809Islk!irzMolcLSdo1 zL>9(B;mN+;_cg{nJm@_C$m`hWP~sy%%1)SyLV-yz3Q}o_vlYX66fdhjNiRhK|7e$ne>_brbAB6izd^|Pku+M^KTrz+Q@mB* zC{)1#e=#Pi%RT^_>ZU9{-lSVwEbXLFF0U;dtrj929gq~%$aFuA(lQ#A%M$|SUcJ;P z1azGIQ#Pat1irr(5IHX?6f00|^DGeg*JVZIR6+QF6T1BNGGssYIi<_N_umB-4CPrM zxim`XzGaDUG;0Rsf?hjT3kgRv_qEzQ`;El1v}5~;&Hj3uXNCWoT6&C7*~sS$5e}17 zRb8T0R)eIF;0?QhMRswR>?-RNqzqNj8#D;LM#85SS*O6tjgCF2vw7z1xJBiN<82$+fhps5MV&g~0sg93VPz3XqrDH<=%SBA)Ky=1|08fp8oxz5P+YZ zFFv5~1-5_|mzKF|j65fN$AD!+d;GbiHd34Ouo zvv*$Pc+yYP9OEi&_f8@v+mMNq)jdo;0rXyH2>8CiJ$95&68+L<|DZ*R{OhaA=NMPo z@>ITJ`4!TpO~X`7vLzay8Tv6NM#qRA@|x$QwJMmM7k53mFiS>YrLQ(qpgO75!5dC-+73Pt#}@QxaO*F76K%=Ep*J(CHw}GBIYrJ67tFIp z^Urp>O26Eg%H+KGdr^QiM5pi&Ldt3#Qla|76!u(9t?iQZw}U1<^)>~63wXDEWLmfG z+gGJ`pm7gBTQ=nC>Z#b&M029cmEZ1aX2zCCm#%fQ;?texgx%$hr*Y2YZNHH|(yi;) zUgWc@G5USa-^984ByIS{Cq8jm!gxDS8C_BTG;h%&uwvkumi(HsDfMB_k4DT!WVe6V z>$3XT_!SDeu-))UjJF-lx9QsAnOBho{`qUm`pj?R>*K{a))KU)J{vYMOstZ>-#hG` zjGaCIm*dd$U3w)!<-du|J&x7vdr#JsCAB%3>uC4#v9^zD_d7vs478i z=D_}qocSgH^5!3(hHfDcw_(+EJ6$tgma3Q^tpg+M7Mi}z7wixb=8wYsKOBAPGZ8sc z(opZF{>A51*%V{WnsBDIB|n4( zqGD=3YlrGx>S?t5Hf^A)oZ^l+jCWop!+6fn zB@^K1^rmwMt{>>itVGAFUl}|6N+8VfaLR6n0dB=*<-nR`Z`pSsUlNuhPC8gZW$Yw} zy;42w+^1vPdl>B}fBWu_!Ws7Q<2Aj~*x~URiCjKqMIRICiL9QhMIx4eaFEJa8l{wc zfb^;)OLfgO=dMEmD)a5Hf|%*|Ay7=}pWEkTwm+|Zio`9}50NsZ7E>JTd4&uYxpdAx zQes8RB4B(4jUwFJ^SfjrH`F46J5x;L!)u;&1wyMlq`Ap+EBIcy&O!L#7td22X2U%{ zc{|~`A2i%_%8*w2wr)mSy_7OmtW}(!gz#Y19V+ACfo@$~g&(P96p6@}&yG&#tIA<3 zCkTv7$?4FGhLxN5zzs`W>JCez{eJRx3t`2qS7G{utaQk6I%Cr;Ef$GR>MpzK(4!*D2R(S`*DAg$V61xH2(**0aF8i`>I`eAo{&z;%cy<=CsX2ubxCnclGE{2D8}UXeB&Jq1>3>R=-CQZ_?&rR>N}Q1b;Fap z#`|5{;LJ;{k-e;R0}w?BG=>zUU4Iu*UZbdPD0=al_p4)Z4%by!lIK&7ai>Riwsc9N zhzK`vuykh#oOVz%&m1J_2Mqj1!gbA-kvezkv-|4sUo#n_;yG{q1mwi#$@4yTa5cBi z@jZHk(!%AP0SiXb?b504RF87Z=56x16kSHN$=uIfro|F`M>tcR@E@H0kaTKmr%U{~ zOL}x-wij74&&>99)LygQV>(0Ta%tWbUSWuHK(I@dA4*z`=(K#LsC>fJJBol6U%DT9 zI*qY~slDjsaJI_Zy}DG@{gQ-m*Z5^CePU+bR}vSSIoCNCLtIIq;)>>mq<_CrI?Hwa zFQ=&(?{~Nb4TPd_vxt@hu1;}@p_GEnmv(4f#c=;QfC(Cm*Cw%!=IxC6v?;qE)w?OZ z8Gdk(eaCZ^=E2+8oNMl3OFXio+>&h5zEATnLx!rWaGmKHZESY>FN=MaNTbbo8vXHA zc%fKrrLD&mUKB%nzjefbF(%f|#@2|ze(c^71d*i?eaBW$U7lVis#ozM6N)XBfaMDc|&h@qWcn7;C@fRLsBG-aIM6 z8ejpTf6>Er4U0c@$x2Ktn*xfb7!(?aJsLNzHFE<+O&hSc#g$43*g2gymIfPFE0R@M zN@o&O^*jW!oPA;ual>zoX#vIq88=Ra9&`=5eTwh&)U&<}5qlp!b(oXs6zR0)V)oTq zZ`%^*{6JNfnTo6`q%slgndyI)+XL2!>AR-X!;g)3E`-2Tk?`Mt?zV*(hiC2>8@!s8 zR!cO#zY5Py&t- zgN=)&48~^%7ZPjF?|WG~tlsILrQ`hSo4HlT!EL+8D=s=hHmh;?xVW_Z#(^;3mM@x7 zzgA^vjBNKsznBUIsx2xw{elsXqH5>h#v?K%ZnKzxglkHcqP$?UTUgX8dC~pDP+JzG z+F><%YCA6IuC0dwp1VrG=h-#B=d5tmHnKp$$H)E;#lL1wvp$fFZ3Al|9E-_6vz2lr zWL^1H_1VG|Fj^kSGM{dR{8pw2LiQ;;T(zYDCXUx>k@!3D5gQxfE9zw@HkW_9ML`$Q zBvYM^&Z46{8h21XofQ!>r~_m1wB5^2ck-8Eo%YpWJ=^|*65@?JLxK-+?+AaodGf|p zSTFy&R+H|0WUqNs`7haH>Q=+QDjnqkWw8~Lz+Erdx#>UL(qAoq!+FMJUe@}ae;~tfo&npTRN&0 I%9cU@4}p^FF#rGn literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml index c678765..2a68689 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,7 +20,7 @@ theme: font: text: Roboto code: Roboto Mono - logo: assets/images/compas_icon_white.png + logo: assets/images/compas_pb.png favicon: public/favicon.ico features: - content.code.copy diff --git a/requirements-dev.txt b/requirements-dev.txt index 1e47a84..37e2db7 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -9,3 +9,6 @@ twine wheel pytest-mock build +mkdocs +mkdocs-material +mkdocstrings[python] From 281bb20270c56e57a61ddadb775a1ceb724f050a Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Mon, 8 Dec 2025 18:59:17 +0100 Subject: [PATCH 06/10] updated changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a1317f..8af1845 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +* Migrated the documentation website to MkDocs Material from Sphinx. + ### Removed From a62aaa3f1d876336a2ab54f57740f7606807b5f8 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Tue, 9 Dec 2025 09:50:16 +0100 Subject: [PATCH 07/10] removed requirements files --- requirements-dev.txt | 14 -------------- requirements.txt | 3 --- 2 files changed, 17 deletions(-) delete mode 100644 requirements-dev.txt delete mode 100644 requirements.txt diff --git a/requirements-dev.txt b/requirements-dev.txt deleted file mode 100644 index 37e2db7..0000000 --- a/requirements-dev.txt +++ /dev/null @@ -1,14 +0,0 @@ -attrs >=17.4 -black >=22.12.0 -bump-my-version -compas_invocations2 -invoke >=0.14 -ruff -sphinx_compas2_theme -twine -wheel -pytest-mock -build -mkdocs -mkdocs-material -mkdocstrings[python] diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index eb4447d..0000000 --- a/requirements.txt +++ /dev/null @@ -1,3 +0,0 @@ -compas >= 2 -protobuf >=6.31.1 -importlib-metadata>=5 ; python_version == '3.9' From 7c11462071b8cbc93da539d3fd545b3f88e967d7 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Tue, 9 Dec 2025 09:58:41 +0100 Subject: [PATCH 08/10] rename docs -> proto_docs, fixed install option in workflow --- .github/workflows/docs.yml | 4 ++-- src/compas_pb/invocations.py | 19 +++++-------------- tasks.py | 4 +--- 3 files changed, 8 insertions(+), 19 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3bc333c..09da12f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,7 +25,7 @@ jobs: - name: Install dependencies run: | - pip install -e .[dev] + pip install -e .[docs] - name: Configure Git Credentials run: | @@ -34,7 +34,7 @@ jobs: - name: Generate Protobuf Docs run: | - invoke docs + invoke proto_docs - name: Deploy to GitHub Pages run: | diff --git a/src/compas_pb/invocations.py b/src/compas_pb/invocations.py index c74c1d3..8115000 100644 --- a/src/compas_pb/invocations.py +++ b/src/compas_pb/invocations.py @@ -182,16 +182,9 @@ def create_class_assets(ctx): print("protobuf class assets are ready for GitHub release upload! find them in: {dist_dir}") -@task( - help={ - "rebuild": "True to clean all previously built docs before starting, otherwise False.", - "doctest": "True to run doctests, otherwise False.", - "check_links": "True to check all web links in docs for validity, otherwise False.", - } -) -def docs(ctx, doctest=False, rebuild=False, check_links=False): - # intercepting the `invoke docs` call so that the protobuf docs are generated first - # the single html file is linked to from the main docs site +@task() +def proto_docs(ctx): + """Generate documentation for protobuf definitions using protoc-gen-doc.""" protoc_path, plugin_path = setup_protoc() proto_files = ctx.proto_folder / "*.proto" target_dir = Path(ctx.base_folder) / "docs" @@ -202,9 +195,7 @@ def docs(ctx, doctest=False, rebuild=False, check_links=False): cmd += " ".join(f"--proto_path={p}" for p in ctx.proto_include_paths) cmd += f" --doc_out={target_dir}" cmd += f" --doc_opt=markdown,protobuf.md {proto_files}" - print(f"Generating protobuf docs with command: {cmd}") - ctx.run(cmd) - dist_dir = Path(ctx.base_folder) / "dist" + print(f"Generating protobuf docs with command: {cmd}") - ctx.run(f"mkdocs build -c -d {dist_dir} -t material") + ctx.run(cmd) diff --git a/tasks.py b/tasks.py index 02d0224..910fe67 100644 --- a/tasks.py +++ b/tasks.py @@ -7,7 +7,6 @@ from compas_pb.invocations import generate_proto_classes from compas_pb.invocations import create_class_assets -from compas_pb.invocations import docs ns = Collection( @@ -20,7 +19,6 @@ build.prepare_changelog, build.clean, build.release, - docs, generate_proto_classes, create_class_assets, ) @@ -29,7 +27,7 @@ { "base_folder": Path(__file__).parent, "proto_folder": Path("./src") / "compas_pb" / "protobuf_defs" / "compas_pb" / "generated", - "proto_include_paths": [Path("./src") / "compas_pb"/"protobuf_defs"], + "proto_include_paths": [Path("./src") / "compas_pb" / "protobuf_defs"], "proto_out_folder": Path("./src"), } ) From f5b2232b9208af49d96fd12e894e8497fe3edfe4 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Tue, 9 Dec 2025 10:31:36 +0100 Subject: [PATCH 09/10] use mike for versioned deploy --- .github/workflows/docs.yml | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 09da12f..44084b3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,12 +2,8 @@ name: docs on: push: - branches: - - main - - pull_request: - branches: - - main + tags: + - 'v*' permissions: contents: write @@ -38,4 +34,4 @@ jobs: - name: Deploy to GitHub Pages run: | - mkdocs gh-deploy --force + mike deploy --push --update-aliases ${{ github.ref_name }} latest From 3620df8d58b4c8801cb1328f7ab6ea544ae21451 Mon Sep 17 00:00:00 2001 From: Chen Kasirer Date: Tue, 9 Dec 2025 14:22:00 +0100 Subject: [PATCH 10/10] COMPAS blue theme and compas white logo --- docs/assets/css/custom.css | 5 ++++ .../images/compas_logo_white_transparent.png | Bin 0 -> 7852 bytes mkdocs.yml | 23 +++++++++++++++--- 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 docs/assets/css/custom.css create mode 100644 docs/assets/images/compas_logo_white_transparent.png diff --git a/docs/assets/css/custom.css b/docs/assets/css/custom.css new file mode 100644 index 0000000..a6f31ae --- /dev/null +++ b/docs/assets/css/custom.css @@ -0,0 +1,5 @@ +:root > * { + --md-primary-fg-color: #0092d2; + --md-primary-fg-color--light: #0092d2; + --md-primary-fg-color--dark: #0092d2; +} \ No newline at end of file diff --git a/docs/assets/images/compas_logo_white_transparent.png b/docs/assets/images/compas_logo_white_transparent.png new file mode 100644 index 0000000000000000000000000000000000000000..5dd158c84d0aeaebe246993a3a6090bc9803e299 GIT binary patch literal 7852 zcmV;d9#i3oP)s0Nakg zcm4YmFTmr`XZ4ByOGM0XNyt%>?T(ziI5XhQ1Z8<(FYIP_JnlYAL_!ks^yG+8jaaXy zEQ|%uh^T8s*hc7y2}nX7mklD^91-qZL_3scM9?*RfhR^F2{}ADaJ~EUa?+BF&nqJ6 z``w?-gk@PYNyz@$Ai_1`y_mE#aq)x*x+3+~UP(gs!=ZRTOk9?^@Qn1-6-m_2Bq6(T z4HP8tx?)6qOESMzBq7_A0XK+%liBQ_Cq&Tqq$#e!Bq0x{*d0srG{?#-Vs@uqdH_kt zr`fRYeWwVs-XpUIGl@^RW?B+ifoeMAzn zkTFjIKe2ZRHR#5YTVx0U)5UXZNrK+7b|G(&itu^ja`f@aK92c?{TQ+C`MxjALXE=( z8yWFB`ks-Y(EZc}nTj)Lj>JSTa58olaMoHEH#yR_{x6qK+Uo%nGyCi(?0K8M9_<8 zEkZ7VFB9C?gdQ3JuaT+a(4UYYR6W7HM`P(i&XHbtOf%XTgJc9;4sE znWYMO3UBleM7*o@oLZ70g1%wAhV~f=@~KC<-)JmR$Xi5AV^of3_PuX2!u^&?jtFe5 zdHluo&Px+=$v9)-2lfI^_#;CEJ;t=))9zl282&6p$Qk2!q<1Nkxqo!bwMX6{4y{n8^lC%>BFC%`4>^YZ#0-5Oa};t&uk`AJ?`J~j z>BT$53Y!gc6LP5W@T$W37Q_~LZy_wR2c*8uV%$6@As4{+0N4G2^ukSmYbVB`Km_f( zfqz28+<3mOcjhAG3je_ZuSf+*X7n=HAYu+tPjVukZ=QqKy2Ag|1;#sSbu2cHS42GW-ta+62dterI=$BatIMGA`Gtw*QuD--T6y>J{i(r`K(XT zi8(eQ`xfyt(ke&osBmD5R45>nqY`sWLiR19nq zfn`5GvpC|()Aha+K{#g&J#vMgdE!}2+aKDcMXWsp+}xx|l%pO6Q*1`%H~UZT2d_IpAtnHyv{ z=8A~`%RF4mnyG|b;3v1%(!H$5jOm2B82NrvQsGa`_e{_LP9fwie#Urf6ETb*?>qMW zrli7;m@k+08xOTBYZNhzzh6~0^8Kc!0)9uFeJ)%v@|4t=LN+3Hoi7Am&UCeJ7VZ0n#$R=&A3nm%Bnni3FyN7H> zzF&+~xCe~{4|@$QFxQ~l(NFqLD?D@%h zVB_UbLN+;*T=?qY8cXAz@yzQ7l4*TRj$2~CHw21d4<%&RWp+PUN6@}4 zFN~LxryS`%bK(WDG+i3g&jg5=3nAni+%o^0eQOil+!DT5{y{RU`*_6NaaG~j#P+=& z*)?-Ta&8SH2mT6l?N=nCE6oy|#x)0+*DN-^d*li?lR7!KhVe+aUipzE;vwAN=KS(% zV*3>GHEs#P??}$Ap@i7y$Z*BFRz11kI$rkX@9Z;+N;J7@fi%(11O;5=L4zk%=Z z%sLlLXt)OcbU6Pj9vq9ldgL420za0Vw$?Xec&&p?lPr*X#5t(t1`myBlU*x2OTN}R{GvV5aE63k|f-?@UVh#a?>1g9*V zu0qanEBrf>mwG5A!}FY-@;MaP_3G&z4W~jMmi&N&lhJjITsoZlM5-V|$*`MqEa^9i zE2Pp4WvocDCE)U`u5hq^T!eg$TLjl75qv@jgN?a%$ME4w$?#x?H!OQUC=EICtp9`G;G9x(l2*v7n+@PI(krJ*BNPlzSon(F zb8E0`B)rUbE`SX2{QrgD&C?BUP>hu|LM{lKUGV~GxvS!cID{jjbCvaOMFGw>&%f1yJ)%JaZ3YKGkgYOO+h?4(m=Y*&S>ksRlK`xk6c=Q z-|&o>CV!w`E%F61w+rR@bE2~N?gQ?*yli^qOP2o*GUOfngGZI+Ew6kq~|f#aoy?#*S7NP%C@_K zD;%zy^_2IgBh*Viq&Rc!kPmQfM``)HegEbgi~G0jG8$1I9ZEIeSu_sUKKnaDy8+VOuxMKWA4nw+}>LLwmfio zY@U4+xGX-8ymcGKwXNGQu2kOh@!YkC+`LlWyc%%rb4Sto89z^5fzBPZ#c#SFp*)#I zdD=FdneX%W*gWGd>ek&SuyMHm$$JmExz+@6{n3X%zEqaM(6r)Io4P`E9fjp@@%3EK z9k&)`igh~5SKY}ymZ?&f=`KSxch~+BU z`Oa#1)z_&WxnKSLJTpyZ%myj%d-NMokC|@BHhoVWs2oGN!7eRO8LlXRyz3en2fHMN z-!fgYgi3i{(fMglYjLe?En@LpmhCi=J41UBn{s4<%At9tQDPXZ36gLBtvD+^cIdm zGgf{>SHgjwmZI_1QbcgXv|Q3A$f9ZE3$iFI%HOtrdOp|Hacvv#>Nu_C`^#)g*TpmC z#bYt6W33Rj&$UqAC-hNU{D#`$J~1`GArI~E`sq4drgg69?jas?rH^~Wx$zaZbVHBm zQr%P*-yO1B#8i|P-_>k`a=2@QHqFj6;`qEKo}oz}nk`xLUq0z*Au2@+F;)UxapW%UVG?ur#ft&UDFP?V&)#?qdBx|{ePN<^3@~PigTuD zt>S#P!^+~iF-$j|!*)9ATu@1lyc3sQ8@>@PtTH5CfAAq;WbDLwTUC9pAN$r~bzL8^e;}UjM#0 z>_>i%jsJ?&$;zQzb3#)GI(y_yaUpHWow?E=t>EuSMQb{~W1GIGbT8KA7)RkyKGR*_ zZV)lQ-Cb{qW^^C5;+zY1*3IFzsx|gwbPM(K{3&gOlx~K*g2eT z88+W;mP@+qjxl6+NmKs68E^N(TkLkJShM4+)|})bs#Y}5CYp6+YR(k=S&vj($!p;;v1gX1h9=Wy}HuZkq(Vc5n~huAHm!F_j( zp_p{DRe)>XU>AqIw&|!^b5auWFnmroxl-f4J4PR7*M^dCvl1`(+odA0BMJFD8FB6w zQQ^KjhQaJ!m^04O)Dk-rwQ%&>K*p2n8FvVB~Nyw+Moo=!Tk_bVKi1Xa?!LP)zYeQl2 z-L=GFtJY;FA@@^Y7lRyAC7W8HLuv4{OU05<{l0&Z@@{ouJKeN|-6E!WxFtV82U67NjK8ktxpkXN77opT4JWw}^y4D(w6=Wtd`& zj<$1bQjcucyY}rCk?>Dx@!h5DQjsand4|1dt?6O3N!((>HhoX>l8#5s`qBbrigOy+ z3%OR_I9Hw*1Ge$hr*?}-grQ_zX@N9WZUa9DglN*nWQucQA*S>_iEbL!l@=&doYTP1 zLe`9vH8+ld4EyvwO^}i#&QW5Q7HG~h3Yx8Z9^q#pH;RkoigRM1B;0Nh3IEtMx^vy7 zLhZ2zcOlQwbDcBJZV?H8+_U_&Kw2&R(j(W3i(D{2^SZS7u8-X!5`I{E9JWTt|1ACd z_rZtS3>RDC8b4;pv{KHm(-9l&#v!Gb5+!_KcBvR@O_g*nb*y*SnmWJQF&ZKNquE0t zzaZm5+gQ(>I37xlygcn5N5_QNEh6E@4I<7V{*4Q|>w@|06{)u+adbqQdi#%%k3%#y zy>hNN$0r#gxWDix;*`E8PHf|_PjP|t?q{(?!&5kuv)dupv!1#f#1A zsG)p8I)ka|ajrbCHh=kd$A4%x!Oj`qye^Raetk3cZV@3k*C01z6e1u6VuAVOiv7M? zW6x6LigSL-arRr=w#Q%i<%0oyV_Yxc7Wi+VYyV)m`Jk4<25F2!#QQ%n{mni8BNTK zYr=L;x$?aF_=CQjUB7&BAR*1`4db=Oi3Egq;ugyDei{Du2|31b@*G!MCFV`YI+vka zf84nnN1u=zbkQ@$ybeJY=(>qSA0aKkLU~?iCwnR#Zfw1B7U;T(#1s_D^Q?tjDQ^^N z+9oaTPmGNwkKGWo-s&Ip=-`x)AJLiDp@KuwR8V4ULe)8KXV+^bpWA6dYhH)wl~a$L zSOOdL!%wx4wR30%{+(W03n7uvQU|!^(8LJG^qSSs9}r?_kZ>?tH~9rp;L7s6bJW-+ z&T~bxfFuzP+f+@igjk$YD$hGvmab)t#}w$+{XXM=tei7mwACHU*iUFlWJpGjF$l4o zF-KQ_UpZsp4%v-S+bX@me`HL}c)esb(tQ%cX|UT5%7qZ2nWgf)vl<-IBZE|GjY<1} ze=&zlDqu*-1>z+`{3Rhb5e!jpGxXNPJI;8}hwhJDDGP9gfAi!K`0DwZhdh%^>X>N= zyTmlqK3}Esye9@sgAEmO%~6gZ3qn1V5GK|u(i5ktuDGcPXJUs~zM7$T(hf55hYES{ z1v~gim;jLizc2F@F{hRgcv2&Ip!$w-s)Bi>z`vM35ym%CD$jdmV0mnWT%iwHE0yP+ zqX7QEJ(TW=<%oDq6v+E`T~c&G^QClY5{WUmL7yhbx;F;BkQ?;9@&(HupC#7I2DkdHI#(-X zkXA?Q!T!wj`zj|AA*j&Dfvb9Ba1-(iZc|EWf2G9I$g$tp!Qd3*?IL7wn^(Rhnb?Wt zu))p2b&JEan5&Rqa9b4dg_L+cu?$M|4z6b$EmT(_gS0~0l~LyWL}Je5xa|^J;uxgj zL&)IPD<=~>F=sZo<@S2OLucko$Tbqix|ysX#vC1j9Z)nz&1JtaT+&JM0adz9;3mK$x|gKLuf+6haTnkd0Tb(o6f($4L z_L-C-C^0@8q%(5yP=nOn#_<{_8AHe*t&wXI`R^n#C&t5w*mXbVZ;TM=G?tKkjF%ya zIWZ2tL>zQne8^Zr26-@_JX|MimKv=7e8-i5S9c&3ck4gbXrXcF8JYNMcU-z^91+V1n3(sf28tU#^~P5HY8D=7g3E ze+9iBQB4w~%2!&+Jpom&i*lJzg^r2N~iM@#U2^ z+!3*eA$}plz6bRYn|(;?otH%k{Eb_x+Ah8^gLwWq2pRUyD&Jx@z4I-}vprXGq(S}? z;M$*jX1gBCULlwEBs7C=ko(3;yPX z4>3-yCcw3WGFKtPUTD6@&4w$)c~X%CJv9X)uJ42qFi1jxf`~oSr1MXoT+Uvg04wp=#XrX_t_9uz#tn9nh3C2vlJo2 z-qd#41#$>i$Qb&O}~saV1)gMW8=5BZKp27RG9h78>a0!j(KG->}Ge= zme;5`?Lhj9-Fob7cWe)iv8|eOnB3C!#O0WTwe`q{ydahNc6Wpbz}Ikri11j5M&K{( z0~qRq|F6-Ju^+o1{yj$;yVwMK%ro*Ht7(fdEo<(PkI9e<5sRP`r%3`nU=3dDp)|Mi4YxD&&9Mgo2^l8FBy^~n9iI)+{=56BQ`X`X&BBq5(?gG{HC#Nm})8)mE0*)MDe zNfNRhIbwdNadcRo5%E^6WFFX+BxD^MM9>BCdv)i;9U|U(+G5O)BxH9?fXOw<^w#hL z8Ta0kdS5k3$bLzp9!3(cXOfV^ks*Snb<6#yOE$B!DAPG5s zHb}2+{)BxNPoIk#%%Tj~i_|R8I9#Zah>#@YWpOC>b0l#ti2nmA<`vwJUg1ap0000< KMNUMnLSTYD|Am_X literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml index 2a68689..b2fe5cb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,13 +14,25 @@ extra: theme: name: material palette: - scheme: slate - primary: indigo - accent: indigo + # Palette toggle for light mode + - scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + primary: indigo + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode font: text: Roboto code: Roboto Mono - logo: assets/images/compas_pb.png + logo: assets/images/compas_logo_white_transparent.png favicon: public/favicon.ico features: - content.code.copy @@ -34,6 +46,9 @@ theme: - search.suggest - toc.follow +extra_css: + - assets/css/custom.css + markdown_extensions: - abbr - attr_list