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.

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

[CIVIS-5427] DOC pin mermaid version for graph rendering in Sphinx docs #5

Merged
merged 1 commit into from
Feb 24, 2023

Conversation

jacksonlee-civis
Copy link
Member

The upstream mermaid has had a change that breaks sphinxcontrib-mermaid we're using to render the graph/network in the Sphinx docs. See mgaitan/sphinxcontrib-mermaid#110

This PR fixes the problem by pinning the mermaid version.

Currently / before this PR:

Screenshot 2023-02-24 at 5 08 47 AM

After this PR (screenshot from my local Sphinx HTML build):

Screenshot 2023-02-24 at 5 09 52 AM

This PR does not require a new PyPI or GitHub release.


NOTE: This repository is public.
Civis employees should not disclose any sensitive information during code review on GitHub.
If necessary, use the Civis-internal ticket for discussion.

Thank you for submitting a pull request to improve this library!
Please complete the following items
(you may create the pull request first and then work through them by pushing
additional commits to your branch):

  • Add a concise title to this pull request on the GitHub web interface.
  • (For Civis employees only) Prepend the title of this pull request with the internal ticket number.
  • Add a description in this box to describe what this pull request is about.
  • [n/a] If code behavior is being updated (e.g., a bug fix), relevant tests should be added.
  • The CircleCI builds should pass, including both the code styling checks as well as the test suite.
  • [n/a] Add an entry to CHANGELOG.md at the repository's root level.

@jacksonlee-civis jacksonlee-civis added the documentation Improvements or additions to documentation label Feb 24, 2023
Copy link
Contributor

@gbolly gbolly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jacksonlee-civis jacksonlee-civis merged commit 02b8015 into main Feb 24, 2023
@jacksonlee-civis jacksonlee-civis deleted the civis-5427-fix-sphinx-mermaid branch February 24, 2023 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants