Repository navigation
Deduplicate references index markdown - #102
Merged
Merged
Conversation
Also added a filter so `conftest` isn't picked up
Contributor
There was a problem hiding this comment.
🟡 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
conftestfrom 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
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Forgot we had filters there :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Also added a filter so
conftestisn't picked upShould get the docs build going again