-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update API docs for packages automatically #14227
Comments
In the majority of cases, there is nothing to auto-generate for CLI based modules so I wouldn't consider it as an issue :) |
Only 4 reviews left! Props to @mkaz for crushing them all. |
|
@nosolosw - I don't think it's a good candidate for |
Agree to remove the "Good first issue". I still think it has value as a master issue, otherwise, things will become too scattered and will be difficult to understand where things stand. |
Some thoughts about how to deal with current "undocumented symbols" that may or may not have a README file:
cc @aduth |
By "include", do you mean output to in a similar way to the demarcations present in the top-level README files? |
To answer my own question, I assume that yes, it would be simple enough to add additional entry points for each of the components to output to their respective |
There's #15421 to teach the handbook to use docgen for doc generation. |
Updated the list of packages. There's some new ones that are easy wins, in case anyone is interested. |
@oandregal are these items still relevant? |
It's been a while since anyone worked on this, so I presume we can safely close it. |
This issue tracks the necessary work to create a command that regenerates the API documentation upon Public API changes.
By adding some code to the top-level README file of a package they get automatically updated. See instructions. There are some packages that may be more involved or need work in the tool that generates the docs (docgen), in which case they have some notes added.
Progress:
Misc:
npm run docs:build
Use a central script instead of one per package to generate docs #14216docgen
. Consolidate doc generation and fix next/prev links issue #15421Packages:
@class
/@memberof
support to auto-document methods, etc. See alsotoken-list
. docgen: add support for classes and groups of things #15178compose
. To be considered afteredit-post
docs are merged, so we can extrapolate what we learned there.@name
tag?compose
. Complex README.withSelect
.@class
/@memberof
support to auto-document methods, etc. See alsoapi-fetch
.The text was updated successfully, but these errors were encountered: