search

scality / runner-manager

Service to manage github Actions self-hosted runners
https://scality.github.io/runner-manager/
Apache License 2.0
7 stars 9 forks source link

docs: Render mermaid graphs #568

Closed lewismiddleton closed 6 months ago

lewismiddleton commented 6 months ago

Add the plugin as a dependency as per installation guide. poetry add mkdocs-mermaid2-plugin --group docs

Add to the mkdocs.yml via plugins syntax

This on it's own is sufficient to get the diagrams to render.

Resolves: #567

lewismiddleton commented 6 months ago

Adding a fence_mermaid_custom format to superfences as per mermaid2 plugin Material theme config didn't seem to change behaviour but seems like is best practice if you want the diagrams to inherit styling from any theming you choose.

plugins: 
  - mermaid2

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
codecov-commenter commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 85.79%. Comparing base (7e869d8) to head (4bbc5a9).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #568 +/- ## ======================================= Coverage 85.79% 85.79% ======================================= Files 31 31 Lines 1218 1218 ======================================= Hits 1045 1045 Misses 173 173 ``` | [Flag](https://app.codecov.io/gh/scality/runner-manager/pull/568/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scality) | Coverage Δ | | |---|---|---| | [api](https://app.codecov.io/gh/scality/runner-manager/pull/568/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scality) | `66.99% <ø> (ø)` | | | [unit](https://app.codecov.io/gh/scality/runner-manager/pull/568/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scality) | `70.77% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scality#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.