-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganized SphinxBuilder
for markdown parsing
#25
base: main
Are you sure you want to change the base?
Reorganized SphinxBuilder
for markdown parsing
#25
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
* 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]>
bc727fd
to
6281b49
Compare
Pinging @clalancette for a re-review following 6281b49, where |
lexerMapping
changes toexhale
arguments into theconditional
support_markdown
block, so that the appropriate Pygmentslexer is only registered if support for markdown was enabled.
support_markdown
option.Signed-off-by: Abrar Rahman Protyasha [email protected]