-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
docs(libs.md): add Sphinx extension #3833
Conversation
Codecov Report
@@ Coverage Diff @@
## main #3833 +/- ##
=======================================
Coverage 92.98% 92.98%
=======================================
Files 91 91
Lines 6770 6770
Branches 1574 1574
=======================================
Hits 6295 6295
Misses 437 437
Partials 38 38 Continue to review full report in Codecov by Sentry.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the addition!
Organizing is a good idea. Perhaps we should divide Libraries into implicit sections (maybe documented in comments), or replace the current headings with these and turn each section into a bulleted list (but I see web components has two items already, so maybe this doesn't work as well...)? I'm thinking Mobile (Android/iOS/Wechat), Web (Angular/Canvas/Vue), and CLI/misc (AsciiMath/Ruby/Rust), and alphabetical within? Or just alphabetical like you suggest. :-)
@@ -60,3 +60,6 @@ you'll need to first convert AsciiMath into LaTeX input, then call KaTeX. | |||
|
|||
- [@rojer/katex-mini](https://github.com/rojer95/katex-mini): A Wechat Mini Program library that uses KaTeX for TeX math rendering. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accidental deletion? This should be kept, unless there's a reason to delete it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The entry is still there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just deleted the empty line at the bottom of the file, or should this also be kept?
docs/libs.md
Outdated
@@ -60,3 +60,6 @@ you'll need to first convert AsciiMath into LaTeX input, then call KaTeX. | |||
|
|||
- [@rojer/katex-mini](https://github.com/rojer95/katex-mini): A Wechat Mini Program library that uses KaTeX for TeX math rendering. | |||
|
|||
### Sphinx Extension |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd maybe remove Extension here. (I think "LaTeX" should also be removed in "Canvas LaTeX".)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed " Extension" from "Sphinx Extension" and also " LaTeX" from "Canvas LaTeX".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks!
🎉 This PR is included in version 0.16.8 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Adds the sphinxcontrib-katex Sphinx extension to the "Extensions & Libraries" section of the documentation.
At the moment the entries under "Libraries" follow no particular order, maybe we order them alphabetically?