Reorganized SphinxBuilder for markdown parsing
#25
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
clalancette
reviewed
Aug 2, 2021
| extensions.append('myst_parser') | ||
| # If markdown support is enabled, the appropriate Pygments lexer must | ||
| # be registered for `.md`/`.markdown` file suffixes | ||
| exhale_args.update({{ |
There was a problem hiding this comment.
Will this work if exhale_args is False but support_markdown is True?
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Addressed in 6281b49.
An alternative to that patch would be to invoke ensure_global on exhale_args, but that may create a needless copy of exhale_args incase enable_exhale is false.
added 2 commits
August 5, 2021 12:40
* Removed a stray TODO comment from an experimental idea for ros-infrastructure#22. * Moved the `lexerMapping` changes to `exhale` arguments into the conditional `support_markdown` block, so that the appropriate Pygments lexer is only registered if support for markdown was enabled. * Added longer description of the `support_markdown` option. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
The `exhale_args` mapping should only be updated with the appropriate Pygments markdown lexer if both markdown support and exhale support are requested. As such, an additional check for `enable_exhale` is added into the markdown support configuration block. An alternative would be to invoke `ensure_global` on `exhale_args`, but that may create a needless copy of `exhale_args` incase `enable_exhale` is false. Signed-off-by: Abrar Rahman Protyasha <[email protected]>
aprotyas
force-pushed
the
aprotyas/organize-markdown-parsing
branch
from
bc727fd
to
6281b49
Compare
|
Pinging @clalancette for a re-review following 6281b49, where |
clalancette
approved these changes
Aug 16, 2021
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.
lexerMappingchanges toexhalearguments into theconditional
support_markdownblock, so that the appropriate Pygmentslexer is only registered if support for markdown was enabled.
support_markdownoption.Signed-off-by: Abrar Rahman Protyasha [email protected]