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

add api workflow #124

Merged
merged 10 commits into from
Oct 1, 2024
Merged

add api workflow #124

merged 10 commits into from
Oct 1, 2024

Conversation

stevenhua0320
Copy link
Contributor

Add api workflow

@bobleesj
Copy link
Contributor

bobleesj commented Sep 27, 2024

Are these generated dynamically by the cookiecutter? It doesn't look like it. It's probably best to have a single PR that both removes older docs and handle generated API so that we don't have to have additional PRs related to docs/workflows.

Screenshot 2024-09-27 at 11 55 29 AM

@stevenhua0320
Copy link
Contributor Author

screenshot of new api page
Screenshot 2024-09-27 at 12 52 04 PM

@bobleesj
Copy link
Contributor

@stevenhua0320 good, now can you follow the API workflow instruction to generate .rst files and render them? There should be a new section called "Package API" Ex) Billingegroup/bg-mpl-stylesheets#66

@bobleesj
Copy link
Contributor

Screenshot 2024-09-27 at 12 56 20 PM

.rst files have been removed - please double check the "Files Changed"

@stevenhua0320
Copy link
Contributor Author

Screenshot 2024-09-27 at 12 56 20 PM .rst files have been removed - please double check the "Files Changed"

Yeah, I removed them right now since it is generated by the old cookiecutter.

@stevenhua0320
Copy link
Contributor Author

updated api workflow build
Screenshot 2024-09-27 at 1 06 39 PM
Screenshot 2024-09-27 at 1 06 31 PM

@bobleesj
Copy link
Contributor

The file extending.rst is not being rendered here in the screenshot?

@stevenhua0320
Copy link
Contributor Author

@bobleesj
Screenshot 2024-09-27 at 1 28 52 PM
Here is the extending srmise page

@bobleesj
Copy link
Contributor

@stevenhua0320 is there nav on the left column for this ? maybe put it under the source?

But then i see that you have two, let's remove the other while ensuring all doc files are copied including licenses, etc.

Screenshot 2024-09-27 at 2 04 05 PM

@stevenhua0320
Copy link
Contributor Author

I've put extending.rst under the source dir but I did not see it is on nav.
Screenshot 2024-09-27 at 2 36 29 PM

@bobleesj
Copy link
Contributor

let's make one? then we can remove the ones that are not needed once deployed (probalby all will be useful)

@bobleesj
Copy link
Contributor

I also see lots of useful content under tutorials let's add those too

@sbillinge
Copy link
Contributor

@bobleesj thanks for the help with this ,🙏

@sbillinge
Copy link
Contributor

Polese let me know when it is ready to merge

@stevenhua0320
Copy link
Contributor Author

Hi Simon @sbillinge, right now the functionality of loading extending.rst and tutorial.rst to the nav on the index page might not be possible right now. But these ones could be searched when typing the keywords. I have made an issue for that. So, we should merge these first.

@sbillinge sbillinge merged commit 2df560c into diffpy:main Oct 1, 2024
3 checks passed
@sbillinge
Copy link
Contributor

ok, understood. Thanks @stevenhua0320

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.

3 participants