Update documentation configuration #140
Merged
Conversation
This file contains 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
- Use new data type for `source_suffix` - Update intersphinx mappings to new locations - Set class member `domain` of `Service` to an initial value. Consuming projects trying to build documentation that linked to apiron would fail, as Sphinx attempts to run `str(cls())` for objects and the `__str__` method for `Service` would access `domain`, which is not set through an initializer but is instead expected to exist on the `Service` class definition before instantiation.
daneah
added
🐛 bug
NazimHAli
approved these changes
Oct 15, 2024
michael-iden
approved these changes
Oct 15, 2024
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.
This change is a: (check at least one)
Is this a breaking change? (check one)
Is the:
What does this change address?
The documentation build currently results in a few warnings, and consuming projects that were trying to build documentation which linked to apiron would fail, as Sphinx attempts to run
str(cls())for referenced objects and the__str__method forServicewould accessdomain, which is not set through an initializer but is instead expected to exist on theServiceclass definition before instantiation.How does this change work?
source_suffixdomaininService.__str__