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

docs(libs.md): add Sphinx extension #3833

Merged
merged 4 commits into from
Jun 13, 2023
Merged

Conversation

hagenw
Copy link
Contributor

@hagenw hagenw commented Jun 13, 2023

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?

@codecov
Copy link

codecov bot commented Jun 13, 2023

Codecov Report

Merging #3833 (a0fa8ba) into main (c3fb74f) will not change coverage.
The diff coverage is n/a.

❗ Current head a0fa8ba differs from pull request most recent head c1a07df. Consider uploading reports for the commit c1a07df to get more accurate results

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c3fb74f...c1a07df. Read the comment docs.

Copy link
Member

@edemaine edemaine left a 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.
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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
Copy link
Member

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".)

Copy link
Contributor Author

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".

@hagenw
Copy link
Contributor Author

hagenw commented Jun 13, 2023

CLI/misc (AsciiMath/Ruby/Rust)

I updated the entries by sorting them alphabetically.
By not grouping them to "Mobile" ... sub-groups, we still have the advantage that you can easily find a language/util in the right navigation menu:

image

Copy link
Member

@edemaine edemaine left a comment

Choose a reason for hiding this comment

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

Looks great, thanks!

@edemaine edemaine enabled auto-merge (squash) June 13, 2023 13:45
@edemaine edemaine merged commit 5dd9bc4 into KaTeX:main Jun 13, 2023
7 checks passed
@KaTeX-bot
Copy link
Member

🎉 This PR is included in version 0.16.8 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants