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

issue when using sphinxcontrib-mermaid extension for sphinx #507

Closed
thjensuit opened this issue Apr 7, 2017 · 3 comments
Closed

issue when using sphinxcontrib-mermaid extension for sphinx #507

thjensuit opened this issue Apr 7, 2017 · 3 comments

Comments

@thjensuit
Copy link

thjensuit commented Apr 7, 2017

Hi everyone,

I have installed sphinxcontrib-mermaid extension as the following guide: https://github.com/mgaitan/sphinxcontrib-mermaid

in a "mermaid-template.rst" file I made a code such below

Mermaid Template
#################

.. mermaid::

    graph LR
    A[Hard edge] -->B(Round edge)
        B --> C{Decision}
        C -->|One| D[Result one]
        C -->|Two| E[Result two]

When running sphinx that threw a warning such below and the flowchart was not generated:

warning: command 'mermaid' cannot be run (needed for mermaid output), check the mermaid_cmd setting.

After that I still installed mermaid-cli as the following guide: https://knsv.github.io/mermaid/#mermaid-cli8

But the warning was still exists and was not generated the flowchart.
May anyone help me in this case?

P.S:

  • OS: window 8.1
  • Sphinx: 1.4.8
  • PhantomJS: 2.1.1
  • Mermaid setup success with command such as mermaid template.mmd or mermaid --help

Thank you for your watching,
Best Regards

@mgaitan
Copy link
Contributor

mgaitan commented Apr 7, 2017

hey @thjensuit, please open this issue in the sphinx-mermaid's tracker, https://github.com/mgaitan/sphinxcontrib-mermaid/issues

meanwhile, could you find the absolute path of mermaid command, and set this as the mermaid_cmd variable in your project's conf.py?

@thjensuit thjensuit reopened this Apr 7, 2017
@thjensuit
Copy link
Author

Moved to mgaitan/sphinxcontrib-mermaid#4

@tylerlong
Copy link
Collaborator

mermaid command line has been moved to https://github.com/mermaidjs/mermaid.cli.

Please let me know if you have problem making it work.

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

No branches or pull requests

3 participants