Skip to content

Deduplicate references index markdown - #102

Merged
gselzer merged 2 commits into
pyapp-kit:mainfrom
gselzer:fix-docs-references
Nov 18, 2026
Merged

gselzer merged 2 commits into
pyapp-kit:mainfrom
gselzer:fix-docs-references

Conversation

@gselzer

@gselzer gselzer commented Nov 18, 2026

Copy link
Copy Markdown
Collaborator

Also added a filter so conftest isn't picked up

Should get the docs build going again

Also added a filter so `conftest` isn't picked up

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The page-level filters replace the global list and drop the private-member exclusion, exposing documented private members in the public API reference.

1 open issue
What changed in this PR

This PR aims to restore the documentation build by consolidating the API reference into a single index page.

Changes:

  • Removes the duplicate API reference page.
  • Updates the theory documentation to link to the retained index.
  • Adds a filter to exclude conftest from the generated API reference.
File Description
docs/​theory.md Updates the API reference link to references/index.md.
docs/​references/​index.md Adds the conftest exclusion filter.
docs/​references.md Deletes the duplicate API reference page.

Review effort: Balanced

Comment thread docs/references/index.md Resolved
@codecov

codecov Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.86%. Comparing base (e77115f) to head (9a90430).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #102      +/-   ##
==========================================
+ Coverage   88.13%   88.86%   +0.72%     
==========================================
  Files          64       64              
  Lines        3305     3349      +44     
==========================================
+ Hits         2913     2976      +63     
+ Misses        392      373      -19     

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

Forgot we had filters there :)
@gselzer
gselzer merged commit 25a4654 into pyapp-kit:main Nov 18, 2026
74 of 78 checks passed
@gselzer
gselzer deleted the fix-docs-references branch November 18, 2026 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants