fix(docs): restore npm run docs script and update TypeDoc configuration#5087
Open
JorgeEscire wants to merge 2 commits intoDSpace:mainfrom
Open
fix(docs): restore npm run docs script and update TypeDoc configuration#5087JorgeEscire wants to merge 2 commits intoDSpace:mainfrom
JorgeEscire wants to merge 2 commits intoDSpace:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
References
Fixes #5058
Description
The npm run docs script was missing from package.json and TypeDoc was not installed as a dependency, making it impossible to generate code documentation as described in the README. This PR restores the TypeDoc functionality by adding TypeDoc as a devDependency, adding the docs script, updating the TypeDoc configuration, and adding /doc/ to .gitignore.
Instructions for Reviewers
List of changes in this PR:
How to test: