Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Reorganized SphinxBuilder for markdown parsing #25

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Reorganized SphinxBuilder for markdown parsing #25

wants to merge 2 commits into from

Commits on Aug 5, 2021

  1. Reorganized SphinxBuilder for markdown parsing 

    * 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]>
    Abrar Rahman Protyasha committed Aug 5, 2021
    Configuration menu
    Copy the full SHA
    fd1e092 View commit details
    Browse the repository at this point in the history

  2. Check exhale support before registering md lexer 

    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]>
    Abrar Rahman Protyasha committed Aug 5, 2021
    Configuration menu
    Copy the full SHA
    6281b49 View commit details
    Browse the repository at this point in the history