Skip to content
This repository was archived by the owner on Mar 11, 2025. It is now read-only.

Repair documentation generator and broaden bundle compatibility #87

Merged
merged 2 commits into from
May 23, 2023

Conversation

Shaptic
Copy link
Contributor

@Shaptic Shaptic commented May 22, 2023

See related stellar/js-stellar-sdk#833.

Docs weren't working before, but they should now:

  • Babel will build a modern JS version of the library for docs (if you yarn build:docs)
  • jsdoc will parse that & build the docs website (if you yarn docs)
  • but in production, an ES5-compatible module will get build (when you yarn prepare, etc.)

Closes #85.

@Shaptic Shaptic requested a review from sreuland May 22, 2023 22:19
"clean": "rm -rf lib/ dist/ coverage/ .nyc_output/",
"docs": "jsdoc -c ./.jsdoc.json --verbose",
"build:node": "yarn _babel && yarn build:ts",
"build:ts": "tsc -p ./tsconfig.json",
Copy link
Contributor

Choose a reason for hiding this comment

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

tsc looks for this file by default in this location also correct, just wanted to understand if the extra config is for something non-default or just readability.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah yeah this is just a copy-paste remnant from stellar-sdk where the files live in config/

@Shaptic Shaptic merged commit b7956c3 into main May 23, 2023
@Shaptic Shaptic deleted the fix-docgen branch May 23, 2023 16:33
stellarsaur pushed a commit that referenced this pull request May 23, 2023
* Generate annotated .js files for docgen
* Use docs env only for jsdoc, development otherwise (thx webpack)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Server class on jsdocs doesn't include docs on methods
3 participants