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

redo api workflow #111

Closed
wants to merge 2 commits into from
Closed

Conversation

yucongalicechen
Copy link
Collaborator

closes #110
redo api workflow because it's not displayed on the website.
double checked it's working on my end
image1
image2

@yucongalicechen yucongalicechen marked this pull request as ready for review October 9, 2024 16:03
Copy link

github-actions bot commented Oct 9, 2024

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.

@yucongalicechen
Copy link
Collaborator Author

For the previous PR, when I clicked on source code for each function it is not linked. Now it's linked as shown in the screenshots above. It seems that there're no files changed in this commit. Do we need to merge like this or would you suggest there're some other things I need to check? @bobleesj

@bobleesj
Copy link
Contributor

bobleesj commented Oct 9, 2024

For the previous PR, when I clicked on source code for each function it is not linked. Now it's linked as shown in the screenshots above. It seems that there're no files changed in this commit. Do we need to merge like this or would you suggest there're some other things I need to check? @bobleesj

You can close this PR.

I noticed the doc building process only occurs when it's published. Hence, your recent PR #106 didn't build the doc by GitHub Actions.

name: Build and Deploy Docs

on:
  release:
    types:
      - published
  workflow_dispatch:
```

I believe once we make a release, the doc will be rendered on the URL. I've also rendered locally and it worked.

@yucongalicechen
Copy link
Collaborator Author

For the previous PR, when I clicked on source code for each function it is not linked. Now it's linked as shown in the screenshots above. It seems that there're no files changed in this commit. Do we need to merge like this or would you suggest there're some other things I need to check? @bobleesj

You can close this PR.

I noticed the doc building process only occurs when it's published. Hence, your recent PR #106 didn't build the doc by GitHub Actions.

name: Build and Deploy Docs

on:
  release:
    types:
      - published
  workflow_dispatch:

I believe once we make a release, the doc will be rendered on the URL. I've also rendered locally and it worked.

Gotcha!

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.

Doc API package module not displayed
2 participants