📚 Fix the sphinx-design example #738
Conversation
Under the `## Extending Sphinx` heading, the text of the example discusses `sphinx-design`, but the pip install command was installing `sphinxcontrib.mermaid`. I see there is a commented-out example, below, which is related to mermaid, so perhaps this missed in a copy/paste.
|
Thanks for submitting your first pull request! You are awesome! 🤗 |
|
Yep cheers 🙏 When mermaid gets fixed, then it can come back out of the shadows lol (mgaitan/sphinxcontrib-mermaid#109) |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #738 +/- ##
=======================================
Coverage 89.96% 89.96%
=======================================
Files 23 23
Lines 2970 2970
=======================================
Hits 2672 2672
Misses 298 298
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
chrisjsewell
changed the title
|
Congrats on your first merged pull request in this project! 🎉 |
|
Oh! I just noticed that you merged it. Thanks! Initially, I had created this PR in draft-mode currently so I could amend the commit message to conform to the guidelines listed at https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages. Is not that considered required in this case? |
no need for the formalities, I cahnaged the PR/commit message to have my emojis and thats all. Thanks for the contribution! |
|
Glad to help. Thanks for the quick merge! |
Under the
## Extending Sphinxheading, the text of the example discussessphinx-design, but the pip install command was installingsphinxcontrib.mermaid. I see there is a commented-out example, below, which is related to mermaid, so perhaps this was missed in a copy/paste.