The automated generation of API documentation is no longer working as expected. It is not producing an updated document per API changes.
Verify the version of @aurodesignsystem/auro-hyperlink you have installed
The current version is:
My project has @aurodesignsystem/auro-hyperlink v3.3.3 installed
To Reproduce
Steps to reproduce the behavior:
Clone this repo if not done alread
Delete the ./docs/api.md file
Run npm run build
See build complete
See no new api. md file is created
Are you able to reproduce this issue on the Auro doc site?
[ ] YES
[x] NO
It's a local build issue, not possible to repro on the docsite.
Expected behavior
Builds should generate a new api.md file.
Additional context
The issue comes from the fact that the definition of the element is outside the .js file and managed via the ./index.js file at the root. It is assumed that since the component definition isn't happening in the .js file itself, this is causing WCA to fail.
Describe the bug
The automated generation of API documentation is no longer working as expected. It is not producing an updated document per API changes.
Verify the version of @aurodesignsystem/auro-hyperlink you have installed
The current version is:
My project has @aurodesignsystem/auro-hyperlink v3.3.3 installed
To Reproduce
Steps to reproduce the behavior:
./docs/api.mdfilenpm run buildapi. mdfile is createdAre you able to reproduce this issue on the Auro doc site?
It's a local build issue, not possible to repro on the docsite.
Expected behavior
Builds should generate a new api.md file.
Additional context
The issue comes from the fact that the definition of the element is outside the .js file and managed via the
./index.jsfile at the root. It is assumed that since the component definition isn't happening in the .js file itself, this is causing WCA to fail.You can go to the playground and see this happen in real-time. https://runem.github.io/web-component-analyzer/ Comment out the definition of the WC and see the document go blank.