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

feat: add mermaid.js support #1302

Merged
merged 4 commits into from
Dec 10, 2024
Merged

Conversation

dgarcia360
Copy link
Collaborator

@dgarcia360 dgarcia360 commented Nov 26, 2024

Adds Mermaid.js support.

How to test

  1. Clone the PR and preview the docs.

  2. Open http://127.0.0.1:5500/examples/diagrams/

  3. Verify the sample diagram renders as expected:

    image

@dgarcia360 dgarcia360 requested review from annastuchlik and removed request for annastuchlik November 26, 2024 11:09
@dgarcia360 dgarcia360 marked this pull request as draft November 26, 2024 11:24
@dgarcia360 dgarcia360 marked this pull request as ready for review November 26, 2024 12:53
@dgarcia360
Copy link
Collaborator Author

@annastuchlik ready for review

@annastuchlik
Copy link
Collaborator

@dgarcia360 I'm getting some errors:

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/mat77/.cache/pypoetry/virtualenvs/sphinx-scylladb-theme-LGaAq45G-py3.10/lib/python3.10/site-packages/sphinx/config.py", line 529, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/mnt/c/Users/AS/Documents/git-repos/temp/sphinx-scylladb-theme/docs/source/conf.py", line 14, in <module>
    MULTIVERSION_CONFIG = fetch_multiversion_configuration(VERSIONS_URL)
NameError: name 'fetch_multiversion_configuration' is not defined

@dgarcia360
Copy link
Collaborator Author

NameError: name 'fetch_multiversion_configuration' is not defined

It looks like you were trying to build this PR with the conf.py edits we applied for #1303 during our latest call.

Could you please try again, making sure there are no edits in conf.py?

@annastuchlik
Copy link
Collaborator

Sorry about that. I've checked this PR on a new workspace and now it's working. Thanks.

Copy link
Collaborator

@annastuchlik annastuchlik left a comment

Choose a reason for hiding this comment

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

LGTM

@dgarcia360 dgarcia360 merged commit 7790055 into scylladb:master Dec 10, 2024
2 of 4 checks passed
@dgarcia360 dgarcia360 deleted the docs-add-mermaid branch December 10, 2024 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants