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

Automate release and documentation upload #181

Open
Xanthorapedia opened this issue Feb 3, 2023 · 5 comments
Open

Automate release and documentation upload #181

Xanthorapedia opened this issue Feb 3, 2023 · 5 comments
Assignees

Comments

@Xanthorapedia
Copy link
Contributor

Summary

We would like a mechanism for automatically updating pypose.org/docs that:

  1. Centralizes artifact building (downloads built artifacts from CircleCI instead of building again as in the current workflow.
  2. Pulls the latest release version and upload it to pypose/pypose.github.io/docs.
  3. Updates pypose/pypose.github.io/docs/versions.html to reflect the newly added doc.

Improvements

More consistent artifact building. No need to manually upload and update docs page.

Risks

No known risks.

Involved components

.github/workflows/python-publish.yml
.circleci/config.yml

@Xanthorapedia Xanthorapedia self-assigned this Feb 3, 2023
@zitongzhan
Copy link
Contributor

Maybe take a look at mmdet. They implemented similar mechanisms.

@wang-chen
Copy link
Member

@zitongzhan Just checked mmdet, they have a similar doc template, but it seems that they don't implement the auto doc versioning. We want something like this: https://pypose.org/docs/versions.html
The current doc v0.2.2 was uploaded manually but we want to make it automatic when new versions are released via this action. Please correct me if I am wrong.

@zitongzhan
Copy link
Contributor

@zitongzhan Just checked mmdet, they have a similar doc template, but it seems that they don't implement the auto doc versioning. We want something like this: https://pypose.org/docs/versions.html
The current doc v0.2.2 was uploaded manually but we want to make it automatic when new versions are released via this action. Please correct me if I am wrong.

I thought they had that since their document version always synchronize with package release. I will take a closer look on this.
image

@wang-chen
Copy link
Member

oh yes, I didn't notice that they put the versioning in the left bottom corner. Thank you!

@zitongzhan
Copy link
Contributor

I found out that the version inside mmdet's document is not part of their compiled html. Instead, it is manage by this service.

@zitongzhan zitongzhan mentioned this issue Mar 10, 2023
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

No branches or pull requests

3 participants