Skip to content

Conversation

@hp77-creator
Copy link
Contributor

@hp77-creator hp77-creator commented Sep 15, 2020

Description

Brief Description of the PR:
To supplement the changes made in the location of files in docs/ to /tools/docs/

Fixes #2161

Type of change

Checklist:

  • I've properly formatted my code according to the guidelines
    • By running Black + Flake8
    • By running pre-commit hooks
  • This PR addresses an already submitted issue for TensorFlow Addons
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • This PR contains modifications to C++ custom-ops

How Has This Been Tested?

If you're adding a bugfix or new feature please describe the tests that you ran to verify your changes:
*

@googlebot
Copy link

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@hp77-creator
Copy link
Contributor Author

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@googlebot I signed it!

@googlebot
Copy link

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@seanpmorgan seanpmorgan mentioned this pull request Sep 16, 2020
2 tasks
Copy link
Member

@seanpmorgan seanpmorgan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per discussion in #2161 please update the documentation in this PR

@hp77-creator
Copy link
Contributor Author

Per discussion in #2161 please update the documentation in this PR

Regarding that I had doubt, Shall I completely remove the documentation related with build_docs.py in docs/ and make a new documentation in tools/docs/ like it was in docs/ ?

@Harsh188
Copy link
Contributor

Harsh188 commented Sep 17, 2020

Update docker/sanity_check.Dockerfile RUN python docs/build_docs.py to RUN python tools/build_docs.py. This should fix the build docs failure.

Copy link
Member

@WindQAQ WindQAQ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for contribution! We also have to modify this line
https://github.com/tensorflow/addons/blob/master/tools/docker/sanity_check.Dockerfile#L97 to

RUN python tools/docs/build_docs.py

deps = [
"//tensorflow_addons",
],
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert this change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on it. thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WindQAQ please review the PR

Copy link
Member

@WindQAQ WindQAQ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@WindQAQ WindQAQ merged commit 13e40e6 into tensorflow:master Sep 18, 2020
jrruijli pushed a commit to jrruijli/addons that referenced this pull request Dec 23, 2020
* Moved build_docs.py and BUILD into /tools/docs/

* Modified paths in documentation

* removing build_docs.py from BUILD

* updating to bazel code format

* Revert "updating to bazel code format"

This reverts commit f97c2ad.

* Revert "removing build_docs.py from BUILD"

This reverts commit 3967d14.

* Updated sanity_check.dockerfile with new path
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor docs directory

5 participants