Add grouped subsections by faridrashidi · Pull Request #694 · rendercv/rendercv

faridrashidi · 2026-03-13T14:05:49Z

Summary

Following #545, this adds first-class support for grouped subsections inside a single PublicationEntry section.

Users can now keep one top-level Publications heading while grouping entries under subsection labels such as Journal Articles, Conference Proceedings, or Pre-prints:

cv:
  sections:
    publications:
      journal_articles:
        - title: ...
          authors: [...]
      conference_proceedings:
        - title: ...
          authors: [...]

This is scoped to publications only. Existing flat publication lists continue to work unchanged.

Changes

Extend section validation to accept either:
- the existing flat homogeneous list
- a grouped publication mapping of subsection_title -> list[PublicationEntry]
Keep grouped subsection support limited to PublicationEntry
Normalize grouped publication sections into render sections with:
- entry_type = "PublicationEntry"
- flattened entries
- ordered subsections
Reuse section title formatting for subsection titles
Process subsection titles in the model processor
Render subsection headings in Markdown and Typst without changing publication entry layout
Skip empty grouped subsections during rendering

Add configurable subsection title spacing through:

design:
  subsection_titles:
    space_above: 0cm
    space_below: 0cm

Update user documentation and regenerate schema.json

Testing

Added test coverage for:

grouped publication section validation
preserving existing flat publication section behavior
rejecting grouped non-publication sections
nested validation error locations for grouped publication input
subsection title processing in the model processor
subsection title spacing in Typst output
Markdown/Typst/HTML grouped-publication rendering output

Verification

uv run pytest tests/schema/models/cv/test_section.py tests/schema/models/cv/test_cv.py tests/schema/test_pydantic_error_handling.py tests/schema/models/design/test_classic_theme.py tests/schema/test_json_schema_generator.py tests/renderer/templater/test_model_processor.py tests/renderer/test_markdown.py tests/renderer/test_typst.py tests/renderer/test_html.py -q
uv run prek run ruff-check ruff-format ty-check --all-files

… model and tests

Copilot

Pull request overview

Adds first-class support for grouped publication subsections (e.g., “Journal Articles”, “Conference Proceedings”) in CV sections, ensuring they validate correctly, render with subsection headings, and produce accurate nested validation error locations.

Changes:

Extend the CV section schema to accept either a flat list of entries or a grouped mapping for PublicationEntry subsections, and expose subsections in the renderable section model.
Update the templater/model pre-processing to render subsection headings and ensure subsection titles are processed consistently.
Add test coverage + golden reference outputs for grouped-publications rendering across Typst/Markdown/HTML, plus docs/schema updates.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/schema/test_pydantic_error_handling.py	Adds coverage for nested schema locations when grouped publication entries fail validation.
tests/schema/models/cv/test_section.py	Adds validation tests for grouped publication subsections and rejection for non-publication grouped entries.
tests/schema/models/cv/test_cv.py	Adds CV-level test ensuring grouped publication sections create subsections as expected.
tests/renderer/testdata/test_typst/sb2nov_grouped_publications.typ	Golden Typst output for grouped publications (sb2nov theme).
tests/renderer/testdata/test_typst/moderncv_grouped_publications.typ	Golden Typst output for grouped publications (moderncv theme).
tests/renderer/testdata/test_typst/engineeringresumes_grouped_publications.typ	Golden Typst output for grouped publications (engineeringresumes theme).
tests/renderer/testdata/test_typst/engineeringclassic_grouped_publications.typ	Golden Typst output for grouped publications (engineeringclassic theme).
tests/renderer/testdata/test_typst/classic_grouped_publications.typ	Golden Typst output for grouped publications (classic theme).
tests/renderer/testdata/test_markdown/grouped_publications.md	Golden Markdown output for grouped publications.
tests/renderer/testdata/test_html/grouped_publications.html	Golden HTML output for grouped publications.
tests/renderer/test_typst.py	Adds Typst renderer test for grouped publications across all themes.
tests/renderer/test_markdown.py	Adds Markdown renderer test for grouped publications.
tests/renderer/test_html.py	Adds HTML renderer test for grouped publications.
tests/renderer/templater/test_model_processor.py	Ensures string processing (e.g., bold keywords) applies to subsection titles and entries.
tests/renderer/conftest.py	Adds a fixture producing a grouped-publications RenderCVModel used by renderer tests.
src/rendercv/schema/models/cv/section.py	Implements grouped publication section support, including subsection modeling and validation.
src/rendercv/schema/models/cv/cv.py	Updates `sections` field description/examples to document grouped publication mappings.
src/rendercv/renderer/templater/templates/typst/SubsectionHeading.j2.typ	Introduces Typst subsection heading template.
src/rendercv/renderer/templater/templates/markdown/SubsectionHeading.j2.md	Introduces Markdown subsection heading template.
src/rendercv/renderer/templater/templater.py	Renders grouped sections with subsection headings and per-subsection entries.
src/rendercv/renderer/templater/model_processor.py	Applies string processors to subsection titles during model preprocessing.
schema.json	Updates generated schema to include `GroupedPublicationEntries` and updated `Section` union.
docs/user_guide/yaml_input_structure/cv.md	Documents YAML structure for grouped publication subsections.

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

You can also share your feedback on Copilot code review. Take the survey.

…formatting

sinaatalay · 2026-03-20T21:37:59Z

Thanks a lot for your work. This is an interesting feature, but I think the right architecture for this would be creating a new entry type which accepts section titles and a list of entries below those section titles, just like the cv.sections field, but as a new entry type. What do you think?

Entry name would be: SubsectionEntry.

Something like this:

cv:
  sections:
    publications:
      - title: Subsection Heading
        entries:
         - A text entry.
      - title: Another subsection
        entries:
         - name: A normal entry.

…ication

faridrashidi · 2026-03-21T01:38:29Z

Thanks @sinaatalay, I agree with this direction. I updated the implementation to use a first-class SubsectionEntry shape for all sections instead of supporting subsections only for publications.

The new behavior is:

a section can be either a flat list of entries, or
a list of subsection entries
each subsection has a title and entries
each subsection infers its own inner entry type independently

So the structure now looks like this:

cv:
  sections:
    selected_work:
      - title: Papers
        entries:
          - title: Example Paper
            authors:
              - Jane Doe
            date: 2024
            journal: Journal of Examples

      - title: Projects
        entries:
          - name: Example Tool
            summary: A small project entry.

      - title: Summary
        entries:
          - Built support for subsection-based sections.

or another example:

cv:
  sections:
    publications:
      - title: Co-First Author
        entries:
          - title: Example Journal Paper
            authors:
              - Jane Doe
              - John Smith
            date: 2024
            journal: Genome Research

      - title: Conferences
        entries:
          - title: Example Conference Paper
            authors:
              - Jane Doe
            date: 2023
            journal: RECOMB

      - title: Preprints
        entries:
          - title: Example Preprint
            authors:
              - Jane Doe
            date: 2025
            journal: bioRxiv

This keeps subsection nesting to one level, and a section still has to choose one top-level shape: either flat entries or subsection entries, but not both mixed together.

sinaatalay · 2026-03-21T11:57:20Z

Thank you. I'll review and merge this before v2.9 release.

faridrashidi · 2026-05-12T13:00:52Z

Hi @sinaatalay, are you planning to merge this PR?

sinaatalay · 2026-05-12T13:17:19Z

Hi @faridrashidi, sorry for the delay. I'm not able to work on the RenderCV package at the moment, but I'll merge this before v2.9.

Add grouped subsections for publication sections

f480ae5

Copilot AI review requested due to automatic review settings March 13, 2026 14:05

Copilot started reviewing on behalf of faridrashidi March 13, 2026 14:06 View session

♻️ Refactor code for improved key handling and type annotations in CV…

21621da

… model and tests

Copilot AI reviewed Mar 13, 2026

View reviewed changes

Comment thread tests/schema/test_pydantic_error_handling.py Outdated

faridrashidi added 3 commits March 13, 2026 10:13

♻️ Refactor key order retrieval in Cv class for improved clarity

9a10376

♻️ Refactor validation error handling in tests for improved clarity

bbd6bfb

✨ Introduce subsection titles configuration for improved publication …

55e78e1

…formatting

faridrashidi added 5 commits March 20, 2026 18:48

✨ Add subsection support to CV and resume templates

882a5e4

♻️ Refactor error handling for clarity in validation error flattening

4d7a3de

✨ Update PDF test files for improved rendering accuracy

ca59a07

Merge remote-tracking branch 'upstream/main' into subsection-for-publ…

d1b2eee

…ication

💚(ci): fix merge-base test failures

07b9898

faridrashidi changed the title ~~Add grouped subsections for publication sections~~ Add grouped subsections Mar 20, 2026

faridrashidi added 2 commits March 20, 2026 19:27

💚(skill): normalize zip metadata across platforms

38ac767

💚(skill): make skill zip deterministic on py314

60aad5b

sinaatalay force-pushed the main branch from 1a9f952 to e9da588 Compare March 20, 2026 23:54

faridrashidi added 2 commits March 20, 2026 20:19

♻️(merge): sync PR branch with upstream main

ccef078

♻️(typst): restore main-aligned generated assets

c520f74

faridrashidi added 2 commits March 21, 2026 23:13

♻️(pr): merge upstream main into subsection-for-publication

7cfb842

♻️(pr): merge upstream main into subsection-for-publication

beee3b6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add grouped subsections#694

Add grouped subsections#694
faridrashidi wants to merge 16 commits into
rendercv:mainfrom
faridrashidi:subsection-for-publication

faridrashidi commented Mar 13, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

sinaatalay commented Mar 20, 2026

Uh oh!

faridrashidi commented Mar 21, 2026 •

edited

Loading

Uh oh!

sinaatalay commented Mar 21, 2026

Uh oh!

faridrashidi commented May 12, 2026

Uh oh!

sinaatalay commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

faridrashidi commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Testing

Verification

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

sinaatalay commented Mar 20, 2026

Uh oh!

faridrashidi commented Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sinaatalay commented Mar 21, 2026

Uh oh!

faridrashidi commented May 12, 2026

Uh oh!

sinaatalay commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

faridrashidi commented Mar 13, 2026 •

edited

Loading

faridrashidi commented Mar 21, 2026 •

edited

Loading