-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Open
Labels
Description
Issue
The documentation build script fails when running npm run docs due to the --polyglot flag no longer
being supported in documentation.js v14.
Error output:
Unknown argument: polyglot
This breaks the format-taginfo-docs CI workflow and prevents successful completion of npm run docs.
Steps to reproduce
- Check out the latest master branch
- Run
npm ci - Run
npm run docs - Observe the error from the documentation build
The issue occurs in scripts/build_api_docs.sh:
documentation build src/nodejs/node_osrm.cpp --polyglot --markdown-toc=false -f md -o docs/nodejs/api.mdThe --polyglot flag was removed in documentation.js v14. This flag was previously used to parse C++
files with JSDoc-style comments.
Specifications
- osrm-backend version: current master branch
- Node.js: v20.x (as used in CI)
- documentation.js version: ^14.0.2 (from package.json)
- Operating system: Ubuntu 22.04 (CI), also reproducible locally on macOS/Linux