-
Notifications
You must be signed in to change notification settings - Fork 617
add bazel command to generate API docs #206
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
Conversation
|
It's still not perfect, I think there are three problems, take tf_addons.activations as an example:
@lamberta @MarkDaoust Hi, can we find a better way to solve those problems? |
|
Gently ping @lamberta @MarkDaoust |
|
@seanpmorgan Sean, do we need to generate api documents for 0.3 release? |
|
@yashk2810 recently added tensorflow/docs@5afa339 that should filter out a few more. |
|
Thank you, Billy, I'll take a try today |
|
So for those three questions:
|
|
@MarkDaoust Awesome, it works. Thanks for your help, Mark! |
|
@seanpmorgan @tensorflow/sig-addons-maintainers Hi, we can preview the document at https://github.com/facaiy/addons/blob/tf_addons_doc_preview/docs/api_docs/python/tfa.md Could you take a look? And I think we can use it to generate API doc for 0.3 release. |
|
@facaiy This looks great, thanks for getting this done it is much needed. My only question would be how do we intend to upload the docs on the release branch given the .gitignore? We could modify the .gitignore on the release branch? Other than that LGTM for merging |
Good question! We have to use |
seanpmorgan
left a comment
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.
Thanks!
* ENH: integrate with bazel * DOC: how to install dependencies * FIX: tf.function and __version__ * DOC: use tfa as short name * DOC: add tutorial in details
* ENH: integrate with bazel * DOC: how to install dependencies * FIX: tf.function and __version__ * DOC: use tfa as short name * DOC: add tutorial in details
Fix #46
Related PRs: #140, #195, #196
I push the documnets generated to my repository, and everyone can preview it at https://github.com/facaiy/addons/blob/tf_addons_doc_preview/docs/api_docs/python/tfa.md