docling icon indicating copy to clipboard operation
docling copied to clipboard

docs: add automatic api reference

Open dolfim-ibm opened this issue 11 months ago • 2 comments
trafficstars

Generate the automatic API documentation for the main Docling components and pipeline options.

Adding more docstrings, specially in the document_converter, will enhance the result.

Checklist:

  • [x] Documentation has been updated, if necessary.
  • [ ] Examples have been added, if necessary.
  • [ ] Tests have been added, if necessary.

dolfim-ibm avatar Nov 29 '24 21:11 dolfim-ibm

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/

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

mergify[bot] avatar Nov 29 '24 21:11 mergify[bot]

image image image

dolfim-ibm avatar Nov 29 '24 21:11 dolfim-ibm