Skip to content

Add TypeDoc and Action for docs creation#1299

Merged
zorkow merged 10 commits intodevelopfrom
feature/tsdoc
Jul 17, 2025
Merged

Add TypeDoc and Action for docs creation#1299
zorkow merged 10 commits intodevelopfrom
feature/tsdoc

Conversation

@zorkow
Copy link
Member

@zorkow zorkow commented Jul 7, 2025

This PR adds

  • The typedoc package and its configuration
  • An action called docs.yml that generates the code documentation on pushing/merging to master branch.

For resulting documentation see here: https://mathjax.github.io/MathJax-src/

I have not yet worked out how to add a favicon.

@zorkow zorkow requested a review from dpvc July 7, 2025 12:53
@codecov
Copy link

codecov bot commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.71%. Comparing base (4d1e195) to head (028a0f9).
Report is 11 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop    #1299     +/-   ##
==========================================
  Coverage    86.71%   86.71%             
==========================================
  Files          337      337             
  Lines        83979    83979             
  Branches      4750     3124   -1626     
==========================================
  Hits         72826    72826             
- Misses       11130    11153     +23     
+ Partials        23        0     -23     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@dpvc dpvc left a comment

Choose a reason for hiding this comment

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

This looks good. It may prompt us to make more descriptive jsDoc comments, even!

I'm wondering if we could use something similar in the MathJax repo to house the current master branch's documentation, with Mathjax-src having the current develop version?

@zorkow zorkow merged commit cc849ac into develop Jul 17, 2025
3 checks passed
@zorkow zorkow deleted the feature/tsdoc branch July 17, 2025 11:58
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