[CLIENT-4425] Docs: fix broken internal references in API documentation#991
Draft
juliannguyen4 wants to merge 70 commits intodevfrom
Draft
[CLIENT-4425] Docs: fix broken internal references in API documentation#991juliannguyen4 wants to merge 70 commits intodevfrom
juliannguyen4 wants to merge 70 commits intodevfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #991 +/- ##
==========================================
+ Coverage 83.48% 83.84% +0.35%
==========================================
Files 99 99
Lines 14402 14442 +40
==========================================
+ Hits 12024 12109 +85
+ Misses 2378 2333 -45 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…t documented _cdt_ctx (or private classes in general). TODO: add this error to ignore list
…typing module to make easier to read
… sphinx doesn't raise an error then.
…name to work, we need to add back these lines.
… to them as types
…. Do the same for the other type aliases.
…ing, just make them public for now. Trying to see if the doc's cross references now work for the other errors
…documented by default. Also fix more errors
…he anchor instead
…xpression isn't actually defined anywhere except in .rst
…ng constructs. Sphinx issue 14003
… of typing constructs. Sphinx issue 14003" This reverts commit ead04be.
…sses one of the errors
…is addresses one of the errors" This reverts commit cadfcf7.
…d syntax is | , anyway
…ror messages aren't specific enough
…ied name in signature is ugly, so need to find way to show without packages/modules
…. The error messages aren't specific enough" This reverts commit 4f4b20d.
for more information, see https://pre-commit.ci
…ndocument TypeBatchPolicyRead to see if an error still happens.
…f the type hints in the module
…ses in aerospike_helpers/batch/record.py evaluate to the real type but TypeCTX and TypePolicy in expressions/map.py do not
…t expressions module is, so try removing autodoc_type_aliases
…yway, there's no circular reference.
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
2 participants
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.
CI/CD: Add job to check internal references in docs
TODO