Skip to content

Unable to build docs #2859

@ckeshava

Description

@ckeshava

I'm getting errors in the documentation generation process. This needs to be investigated.

Here is a snippet of errors:

➜  xrpl.js git:(v4.1.0) npm run docgen

> docgen
> lerna run docgen --stream

lerna notice cli v4.0.0
lerna info versioning independent
lerna info Executing command in 1 package: "npm run docgen"
(node:54000) [DEP0060] DeprecationWarning: The `util._extend` API is deprecated. Please use Object.assign() instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
xrpl: > xrpl@4.1.0 docgen
xrpl: > tsc --build tsconfig.docs.json && typedoc && echo js.xrpl.org >> ../../docs/CNAME
xrpl: ../../node_modules/typedoc/dist/lib/output/themes/MarkedPlugin.d.ts(3,43): error TS1005: ';' expected.
xrpl: ../../node_modules/typedoc/dist/lib/output/themes/MarkedPlugin.d.ts(3,48): error TS1005: '(' expected.
xrpl: ../../node_modules/typedoc/dist/lib/output/themes/MarkedPlugin.d.ts(3,79): error TS1005: ')' expected.
xrpl: ../../node_modules/typedoc/dist/lib/utils/options/declaration.d.ts(1,57): error TS1005: ';' expected.
xrpl: ../../node_modules/typedoc/dist/lib/utils/options/declaration.d.ts(1,62): error TS1005: '(' expected.
xrpl: ../../node_modules/typedoc/dist/lib/utils/options/declaration.d.ts(1,93): error TS1005: ')' expected.
xrpl: ../../node_modules/typedoc/dist/lib/utils/options/defaults.d.ts(1,46): error TS1005: ';' expected.
xrpl: ../../node_modules/typedoc/dist/lib/utils/options/defaults.d.ts(1,51): error TS1005: '(' expected.
xrpl: ../../node_modules/typedoc/dist/lib/utils/options/defaults.d.ts(1,82): error TS1005: ')' expected.
xrpl: npm error Lifecycle script `docgen` failed with error:
xrpl: npm error code 1
xrpl: npm error path /Users/ckeshavabs/xrpl.js/packages/xrpl
xrpl: npm error workspace xrpl@4.1.0
xrpl: npm error location /Users/ckeshavabs/xrpl.js/packages/xrpl
xrpl: npm error command failed
xrpl: npm error command sh -c tsc --build tsconfig.docs.json && typedoc && echo js.xrpl.org >> ../../docs/CNAME
lerna ERR! npm run docgen exited 1 in 'xrpl'

I'm using the following enviroment on my Mac OS:

➜  xrpl.js git:(v4.1.0) npm -v
10.8.3
➜  xrpl.js git:(v4.1.0) node -v
v22.9.0

This is observed at the tip of 11e7242

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions