Skip to content
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

converge management documentation generation to the same methodology … #16369

Merged
merged 2 commits into from
Feb 17, 2021

Conversation

scbedd
Copy link
Member

@scbedd scbedd commented Jan 27, 2021

…in preparation for deleting generate_doc.py

Hey @changlong-liu this is out of the blue, but @sima-zhu tagged me on another PR that prompted me to start this process.

When you get a few minutes, can you please take a look at this PR? It has some changes of substance for what you see on github.io, but nothing gamebreaking.

You don't need to worry about getting a direct comparison, I've gotten that done for you already!

For acceptance, please compare the results of a sphinx run of azure-mgmt-storage.

Grab these two artifacts:

And compare them.

Really the main difference is how the ToC is generated.

image
image

@sima-zhu
Copy link
Contributor

Thanks for taking the step! We can completely remove the generate_doc.py once the PR got merged in, right?

@scbedd
Copy link
Member Author

scbedd commented Jan 28, 2021

@sima-zhu yep. That's right.

Copy link
Contributor

@sima-zhu sima-zhu left a comment

Choose a reason for hiding this comment

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

LGTM

@changlong-liu
Copy link
Member

Add @jsntcy @msyyc for review.

Hi @scbedd , thanks for the detail information! The generated doc looks almost the same from before to after.
The mgmt SDK has been transferred to Yu's team, so I'm no longer the mgmt owner :)

@jsntcy
Copy link
Member

jsntcy commented Feb 2, 2021

@nickzhums, could you check the difference for the document?
@scbedd, LGTM. Do we need take any actions from mgmt. side after you merge this PR?

@scbedd
Copy link
Member Author

scbedd commented Feb 2, 2021

@jsntcy Nope other than that you folks ack that:

yeah we accept that our github.io will look different after this

👍

@scbedd scbedd marked this pull request as ready for review February 2, 2021 02:58
@scbedd
Copy link
Member Author

scbedd commented Feb 3, 2021

@nickzhums once you sign off on this, I'll merge it. Waiting to merge till you do 👍

@nickzhums
Copy link
Contributor

@nickzhums once you sign off on this, I'll merge it. Waiting to merge till you do 👍

approved, thanks!

@scbedd
Copy link
Member Author

scbedd commented Feb 4, 2021

@nickzhums

Thank you! Not going to merge this today as it does touch code that gets used in release. Next week sometime.

Thanks!

@scbedd scbedd merged commit 5d1bba9 into Azure:master Feb 17, 2021
scbedd added a commit to scbedd/azure-sdk-for-python that referenced this pull request Mar 11, 2021
…e#16363)"

Revert "converge management documentation generation to the same methodology … (Azure#16369)"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants