Skip to content

Split API members into separate pages - #2093

Merged
shimat merged 1 commit into
mainfrom
agent/split-api-member-pages
Jul 26, 2026
Merged

Split API members into separate pages#2093
shimat merged 1 commit into
mainfrom
agent/split-api-member-pages

Conversation

@shimat

@shimat shimat commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Split DocFX managed-reference members into dedicated pages so large types such as Cv2 no longer render hundreds of method details in one document. Also filter OpenCvSharp.Internal.* from metadata and build input so NativeMethods and other implementation-only APIs do not inflate the site or search index, even when stale generated YAML is present locally.

The generated Cv2 class page falls from 1,289,216 bytes to 265,793 bytes, a 79.4% reduction, and links to 611 dedicated member pages. The complete generated site is 84.1 MiB and contains no Internal API pages.

Test plan

  • Generate API metadata and the complete site with DocFX 2.78.5
  • Build the final filtered site with 0 warnings and 0 errors
  • Verify representative class, member, guide, xref, and search-index outputs
  • Run git diff --check

Summary by CodeRabbit

  • Documentation
    • Improved generated API documentation organization with separate pages for members.
    • Excluded internal APIs from published documentation.
    • Added filtering rules to keep internal implementation details out of the API reference.

@shimat shimat added the enhancement New feature or improvement to OpenCvSharp label Jul 26, 2026
@shimat shimat self-assigned this Jul 26, 2026
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 6874b035-0a30-47db-9fd5-ffa2934dcdb2

📥 Commits

Reviewing files that changed from the base of the PR and between 99e4b9b and 68035c3.

📒 Files selected for processing (2)
  • docs/docfx/docfx.json
  • docs/docfx/filterConfig.yml

📝 Walkthrough

Walkthrough

DocFX configuration now applies an API filter, renders members on separate pages, and excludes generated documentation for OpenCvSharp.Internal APIs.

Changes

DocFX API filtering

Layer / File(s) Summary
Configure API filtering and page layout
docs/docfx/docfx.json, docs/docfx/filterConfig.yml
DocFX applies filterConfig.yml, uses separate member pages, and excludes OpenCvSharp.Internal API content.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • shimat/opencvsharp#2088: Both changes modify DocFX generation configuration, including API content and metadata handling.

Suggested labels: enhancement

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: DocFX API members are split into separate pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/split-api-member-pages

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@shimat
shimat merged commit 718e818 into main Jul 26, 2026
17 checks passed
@shimat
shimat deleted the agent/split-api-member-pages branch July 26, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or improvement to OpenCvSharp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant