[felixdittrich92]

What

A full refactor of the documentation: a new structure, rewritten pages, and a new theme.

Changes

• Structure: 46 pages in seven sections (Get started, User guide, Model zoo, Training, Deployment, API reference, Community), written in MyST Markdown instead of reStructuredText.
• Content: every page is about one task and starts with a snippet. New pages cover core concepts, working with results, KIE, task-specific predictors, configuration and offline use, and an FAQ.
• Real outputs: the snippets were run against the current code on a sample invoice that readers can download from the docs.
• Theme: pydata-sphinx-theme with light and dark modes, the built-in version switcher, a banner on old versions, and self-hosted fonts. furo, recommonmark and sphinx-markdown-tables are no longer used.
• Redirects: every old URL (modules/*, using_doctr/*...) redirects to its new page.
• Generated content: the vocabulary table is built from doctr.datasets.VOCABS at build time.
• Build: build.sh passes the selected version to the switcher and renders older releases in a compatibility mode. docs/README.md explains how to write and build the docs.

Fixed along the way

• The default detection model was documented as db_resnet50 instead of fast_base.
• The datasets guide imported a DataLoader that no longer exists and unpacked samples as img, target.
• The ONNX example wrote vitstr.onnx.onnx.
• The old version switcher listed a nonexistent v1.1.1 release and left out v1.0.1.
• The API reference was missing db_resnet34, Table / TableCell, OrientationDataset, GaussianBlur...

Notes

• Until the next release, the stable docs show the v1.1.0 content in the new theme. At release time, update docs/source/_static/switcher.json and docs/build.sh.

Build locally

pip install -e ".[viz,html,docs]"
make docs-single-version   # from the repository root

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.73%. Comparing base (7363a24) to head (b1b0747).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2185   +/-   ##
=======================================
  Coverage   97.72%   97.73%           
=======================================
  Files         170      170           
  Lines       10932    10932           
=======================================
+ Hits        10683    10684    +1     
+ Misses        249      248    -1     

Flag	Coverage Δ
unittests	97.73% <ø> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.