osrm-backend icon indicating copy to clipboard operation
osrm-backend copied to clipboard

Documentation build fails with "Unknown argument: polyglot" error

Open afarber opened this issue 1 month ago • 0 comments

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

  1. Check out the latest master branch
  2. Run npm ci
  3. Run npm run docs
  4. 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.md

The --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

afarber avatar Nov 15 '25 16:11 afarber