Skip to content

Conversation

@juleswg23
Copy link
Collaborator

@juleswg23 juleswg23 commented Oct 23, 2025

This pull request makes several improvements to the project structure, documentation, and CI workflow.

  • We added core MJML tag classes with rendering and HTML conversion functionality. These tag functions are auto-generated MJML by a Python script: emailer_lib/mjml/scripts/generate_tags.py.
  • Test suites for MJML core functionality and tag behavior
  • Added targets for building docs, running tests, and generating MJML tags
  • Updated CI paths to reflect new project structure
  • Removed old reference documentation files (now generated in docs/)

Tags are generated programmatically from the list of tags found in the mjml docs

@github-actions
Copy link

github-actions bot commented Oct 23, 2025

PR Preview Action v1.6.2

🚀 View preview at
https://posit-dev.github.io/email-for-data-science/pr-preview/pr-11/

Built to branch gh-pages at 2025-10-27 20:17 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@juleswg23 juleswg23 requested a review from Copilot October 27, 2025 20:05
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds MJML authoring support to the emailer-lib package and consolidates the documentation structure. Tags are programmatically generated from the official MJML specification rather than manually maintained.

Key changes:

  • Added Python MJML authoring module with auto-generated tag functions
  • Restructured project by moving reference docs from root to docs/ directory
  • Removed legacy emailer-lib/ subdirectory in favor of top-level package structure

Reviewed Changes

Copilot reviewed 45 out of 73 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
pyproject.toml Updated package configuration, moved dev dependencies, added test paths for MJML tests
emailer_lib/mjml/_core.py Core MJML tag classes with rendering and HTML conversion functionality
emailer_lib/mjml/tags.py Auto-generated MJML tag functions (1559 lines)
emailer_lib/mjml/scripts/generate_tags.py Script to programmatically generate tag functions from MJML specification
emailer_lib/mjml/tests/test_*.py Test suites for MJML core functionality and tag behavior
examples/*.py Updated import paths from data_polars to docs.data_polars
docs/_quarto.yml Added MJML authoring section with all MJML tags to documentation
Makefile Added targets for building docs, running tests, and generating MJML tags
.github/workflows/ci.yml Updated CI paths to reflect new project structure
reference/* Removed old reference documentation files (now generated in docs/)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@juleswg23 juleswg23 merged commit 4c89d7e into main Oct 27, 2025
3 checks passed
@juleswg23 juleswg23 deleted the refactor-docs branch November 3, 2025 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants