-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Fix and extend the auto doc-gen script #2129
Fix and extend the auto doc-gen script #2129
Conversation
* Add experimental script to sync API docs from code * sync-api-docs: Support methods * [remove before merging] Sync some API docs * [remove before merging] Netlify fix * sync-api-docs: add docs extraction script * sync-api-docs: Improvements to method docs * sync-api-docs: update docgen fork to 0.0.1 * [remove before merging] write extracted.json * sync-api-docs: pass filename into react-docgen * sync-api-docs: don't use PropTypes composition handler We have Flow types for this. * sync-api-docs: remove unused comment-parser * sync-api-docs: bump docgen fork to 0.0.2 * [remove before merging] update Markdown files * Sync docs with upstream Co-authored-by: Moti Zilberman <motiz88@gmail.com> Co-authored-by: Aniket Kumar <aniketkumar049@gmail.com>
Co-authored-by: Aniket Kumar <aniketkumar049@gmail.com> Co-authored-by: Ayush Jain <ayushjainrksh@gmail.com>
Deploy preview for react-native ready! Built with commit b25f2b1 https://deploy-preview-2129--react-native.netlify.app Changes to Thank you for your contributions. |
Thanks for your help here @Simek! I realised I should have probably squashed this the second after I hit "merge", hope that's fine... |
@motiz88 This PR should not be merged before the docs autogen demo next week 😞 |
website/package.json
Outdated
"fs-extra": "^5.0.0", | ||
"glob": "^7.1.2", | ||
"glob-promise": "^3.3.0", | ||
"he": "^1.2.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary
The PR is part of an effort to extend the prior-art by @motiz88 for generating docs from comments. The project is a part of MLH Fellowship program and involves the automatic generation of the website docs from code comments and flow types as the end result.
To learn more about the project you can visit the project wiki:
Changes
@type
annotation.@platform
annotation from the comments.defaultProps
or@default
annotation from the comments.required
label for the props parsed from the FlowType(following the latest docs convention).android
orios
parsed from@platform
annotation (following the latest docs convention).Preview (generated with scripts):
Changelog
[Internal]