feat: rendering of checkboxes in markdown

[ErikApption]

This PR is to address docling-project/docling#2167

Checkboxes are labelled correctly by docling but are not rendered in the markdown.

• This PR prepends [x] or [ ] to any text that is labelled as checkbox through markdown.py serializer.
• A new unit test is added and follows other unit tests. The test is based on this form
• No regression error on other tests

[github-actions]

✅ DCO Check Passed

Thanks @ErikApption, all your commits are properly signed off. 🎉

[mergify]

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

🟢 Require two reviewer for test updates

Wonderful, this rule succeeded.

When test data is updated, we require two reviewers

• #approved-reviews-by >= 2

[dosubot]

Related Documentation

Checked 2 published document(s). No updates required.

^{How did I do? Any feedback?}  

[dolfim-ibm]

Interesting. More a curiosity: Do we know if the marko library we use in Docling to parse markdown will understand these checkboxes?

[PeterStaar-IBM]

I think we need to follow the standard markdown convention. In standard Markdown, checkboxes are represented using this syntax:

Unselected checkbox:

- [ ] Unchecked item

Selected checkbox:

- [x] Checked item

[PeterStaar-IBM]

@ErikApption Could you do the fixes we requested?

[ErikApption]

@ErikApption Could you do the fixes we requested?

Done. Alternatively was wondering about making the checkbox renders as parameters the same way there is a parameter for page break but I think this will be a better ootb experience

[PeterStaar-IBM]

@ErikApption Could you do the fixes we requested?

Done. Alternatively was wondering about making the checkbox renders as parameters the same way there is a parameter for page break but I think this will be a better ootb experience

ok now you will need to rerun the test to generate the update ground-truth files and after that run the pre-commit (uv run pre-commit --all-files)

[ErikApption]

@ErikApption Could you do the fixes we requested?

Done. Alternatively was wondering about making the checkbox renders as parameters the same way there is a parameter for page break but I think this will be a better ootb experience

ok now you will need to rerun the test to generate the update ground-truth files and after that run the pre-commit (uv run pre-commit --all-files)

Updated the truth files. All unit tests are passing again

[PeterStaar-IBM]

@ErikApption Could you do the fixes we requested?

Done. Alternatively was wondering about making the checkbox renders as parameters the same way there is a parameter for page break but I think this will be a better ootb experience

ok now you will need to rerun the test to generate the update ground-truth files and after that run the pre-commit (uv run pre-commit --all-files)

Updated the truth files. All unit tests are passing again

yes, but you also need to run the formatting, you should see,?

taa@Munlochy docling-core % uv run pre-commit run --all-files
Black....................................................................Passed
isort....................................................................Passed
autoflake................................................................Passed
MyPy.....................................................................Passed
Flake8...................................................................Passed
Pytest...................................................................Passed
Docs.....................................................................Passed
uv-lock..................................................................Passed

[ErikApption]

yes, but you also need to run the formatting, you should see,?

Got it! I was missing the run twice from your previous pre-commit command

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[PeterStaar-IBM]

lgtm!

[PeterStaar-IBM]

@ErikApption nearly there, seems you need to sign of every commit (-s flag in git commit).