[Sriram-Nambiar]

Fixes #959

When generating documentation, Doxygen evaluates #if defined(LIBZIM_WITH_XAPIAN) as false because the macro is not defined in the Doxygen configuration. Consequently, all Xapian-dependent methods (such as zim::setICUDataDirectory and Xapian search/suggestion APIs) were missing from the generated ReadTheDocs documentation.

Changes

• In docs/conf.py: Enabled Doxygen preprocessing and macro expansion, and predefined LIBZIM_WITH_XAPIAN=1 and LIBZIM_API=.
• In .readthedocs.yaml: Ensured doxygen is installed in the build container via apt_packages.

[Sriram-Nambiar]

Hi @kelson42, if you have some time, please approve the workflow run. Thank you

[Copilot]

Copilot review overview

🟢 Approval recommended

The focused configuration changes correctly expose conditional Xapian APIs during documentation builds.

Review effort: Balanced
Findings: None

What changed in this PR

Updates documentation generation so Xapian-dependent APIs appear in Read the Docs.

Changes:

• Configures Doxygen preprocessing and Xapian macro definitions.
• Installs Doxygen in the Read the Docs environment.

File	Description
docs/​conf.py	Enables preprocessing and predefined macros.
.readthedocs.yaml	Adds the Doxygen system package.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.72%. Comparing base (ae0212c) to head (09916e8).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1136   +/-   ##
=======================================
  Coverage   56.72%   56.72%           
=======================================
  Files         100      100           
  Lines        5056     5056           
  Branches     2239     2239           
=======================================
  Hits         2868     2868           
  Misses        714      714           
  Partials     1474     1474           

☔ 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.

[Sriram-Nambiar]

Hi @kelson42 just checking in on this, all checks are passing and it is approved please tell me if there is anything else that I need to provide before it can be merged. Thank you!

[kelson42]

@Sriram-Nambiar Sorry for my lack of feedback. It has been reviewed and I will merge it. Thank you very much!

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.