Skip to content

New: expose buildDocs() for programmatic documentation builds (fixes #53)#54

Merged
taylortom merged 1 commit into
masterfrom
issue-53
Jul 10, 2026
Merged

New: expose buildDocs() for programmatic documentation builds (fixes #53)#54
taylortom merged 1 commit into
masterfrom
issue-53

Conversation

@taylortom

Copy link
Copy Markdown
Collaborator

Fixes #53

New

  • Add buildDocs({ rootDir, outputDir, verbose }) in lib/buildDocs.js — the documentation build as a promise-returning function (no process.argv, no process.exit), returning the resolved output directory. Exposed as the package main.

Update

  • bin/docgen.js is now a thin CLI wrapper over buildDocs; the --rootDir, --outputDir and --verbose flags behave exactly as before.

Testing

  • npx standard
  • node --test — existing specs pass (the swagger.spec.js CSS-path failure is a pre-existing workspace-hoisting artifact, unrelated to this change).
  • Smoke-built the full documentation via both the CLI wrapper and a direct buildDocs() call — index.html plus the backend/manual/rest sections generated.

@taylortom
taylortom merged commit 8efd684 into master Jul 10, 2026
3 checks passed
@taylortom
taylortom deleted the issue-53 branch July 10, 2026 14:08
github-actions Bot pushed a commit that referenced this pull request Jul 10, 2026
# [1.5.0](v1.4.6...v1.5.0) (2026-07-10)

### Chore

* replace legacy new.yml with direct add-to-project workflow ([33c55ce](33c55ce))
* trigger add-to-project on reopened issues and PRs ([02d2672](02d2672))

### Docs

* Add README ([9b017b3](9b017b3))

### New

* expose buildDocs() for programmatic documentation builds (fixes #53) (#54) ([8efd684](8efd684)), closes [#53](#53) [#54](#54)
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Development

Successfully merging this pull request may close these issues.

Expose the documentation build as a programmatic function

1 participant