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

fix: mismatch between tsconfig.json and typedoc.json (Close #112) #116

Merged
merged 6 commits into from
May 2, 2024

Conversation

hoodmane
Copy link
Member

The parameter jsdoc_config_path was pointing to typedoc --tsconfig which is the compiler options, it should be the typedoc configuration typedoc --options

I added a parameter jsdoc_tsconfig_path to be able to specify the typedoc --tsconfig if needed

I updated unit test and doc.

It is a breaking change so we might want to bump version or add migration note. Available to update the PR as needed.

From @loopingz.

@hoodmane hoodmane changed the title fix: mismatch between tsconfig.json and typedoc.json (Close #80) fix: mismatch between tsconfig.json and typedoc.json (Close #112) May 2, 2024
@hoodmane
Copy link
Member Author

hoodmane commented May 2, 2024

Would be nice to add some tests but I guess we can merge as-is and add tests when I break it...
Thanks @loopingz @dbrnz and @gdevenyi.

@hoodmane hoodmane merged commit 92451b8 into pyodide:master May 2, 2024
6 checks passed
@hoodmane hoodmane deleted the fix-typedoc-parameter-2 branch May 2, 2024 13:13
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.

3 participants