allow registering entities for non-translating builders #936
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
This extension opted towards not registering directives, nodes and roles into the Sphinx application in order to be flexible for users opting to use directives/roles without `only` directive protection. This could result in exceptions being raised when a translator (such as `html`) could not processing a generated Confluence node type. However, this also causes issues for unique builders such as Sphinx's linkcheck builder or sphinxcontrib.spelling [1], where warnings are generated for unknown directives/roles, making it hard to know if a build is failing for either a bad-link/spelling versus the use of an unknown directive/role. In attempts to be even more flexible, this extension will permit the registration for these entities when it detects that an active builder has no translator (i.e. low risk of an unknown node exception). This should prevent any undesired unknown warnings for builders who do not explicitly care about unknown node types. Finally, to support any odd case that has not been considered which may block a user from registering these entities, this extension has added an `confluence_adv_disable_init` option which will always restrict registration for a documentation set. [1]: https://sphinxcontrib-spelling.readthedocs.io/ Signed-off-by: James Knight <[email protected]>
jdknight
deleted the
allow-entity-registration-on-non-translating-builders
branch
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 extension opted towards not registering directives, nodes and roles into the Sphinx application in order to be flexible for users opting to use directives/roles without
onlydirective protection. This could result in exceptions being raised when a translator (such ashtml) could not processing a generated Confluence node type.However, this also causes issues for unique builders such as Sphinx's linkcheck builder or sphinxcontrib.spelling 1, where warnings are generated for unknown directives/roles, making it hard to know if a build is failing for either a bad-link/spelling versus the use of an unknown directive/role.
In attempts to be even more flexible, this extension will permit the registration for these entities when it detects that an active builder has no translator (i.e. low risk of an unknown node exception). This should prevent any undesired unknown warnings for builders who do not explicitly care about unknown node types.
Finally, to support any odd case that has not been considered which may block a user from registering these entities, this extension has added an
confluence_adv_disable_initoption which will always restrict registration for a documentation set.