feat: included sphinx mermaid python requirement#250
Open
Shubhangi-Nikam26 wants to merge 2 commits into
Open
Conversation
Shubhangi-Nikam26
requested review from
LittleHuba,
castler,
hoe-jo,
limdor and
ramceb
as code owners
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR makes Mermaid support configurable in rules_score and keeps it disabled by default, as requested for S-Core.
When Mermaid is not enabled, Sphinx does not load the Mermaid extension.
When Mermaid is enabled, the extension is loaded and available for docs that use Mermaid directives.
Problem
The documentation toolchain did not include Mermaid support in its Sphinx setup. As a result, builds failed when encountering mermaid directives because they were treated as unknown directives.
Changes
Added a new Bazel build setting: enable_mermaid (default False)
Updated Sphinx conf template generation to pass ENABLE_MERMAID from Bazel
Updated conf templates to append sphinxcontrib.mermaid only if ENABLE_MERMAID is true
Add sphinxcontrib-mermaid to the documentation Python requirements