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.

Sign up for GitHub

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

Jump to bottom

Document the API #216

Merged
merged 18 commits into from
Apr 18, 2024
Merged

Document the API #216

merged 18 commits into from
Apr 18, 2024

Conversation

prjemian
Copy link
Contributor

@prjemian prjemian added the documentation Improvements or additions to documentation label Mar 23, 2024
@prjemian prjemian added this to the v1.0 milestone Mar 23, 2024
@prjemian prjemian self-assigned this Mar 23, 2024
@prjemian
Copy link
Contributor Author

Add steps to the docs workflow so the built docs are downloadable for review.

@prjemian prjemian marked this pull request as ready for review March 23, 2024 16:13
@prjemian
Copy link
Contributor Author

@rodolakis @MDecarabas - Ready for review. Download and examine the docs built (from the GitHub workflow): https://github.com/BCDA-APS/gemviz/actions/runs/8402982182

@prjemian
Copy link
Contributor Author

prjemian commented Apr 6, 2024

I'm ready to merge this PR.

@rodolakis
Copy link
Collaborator

@prjemian I do not see how to open the documentation from the link you provided.

@prjemian
Copy link
Contributor Author

Click the link and look for the download at the page bottom:
image

Once the download is complete, unzip, go into the folder, and open index.html in your local web browser.

@rodolakis
Copy link
Collaborator

It does not look like what you showed me on Friday:
image

@prjemian
Copy link
Contributor Author

It does not look like what you showed me on Friday

I agree. I'll let you know when ready to download and view again.

@prjemian
Copy link
Contributor Author

@rodolakis -- This page has the most recent downloadable: https://github.com/BCDA-APS/gemviz/actions/runs/8694842061

@prjemian prjemian merged commit 2342915 into main Apr 18, 2024
6 checks passed
@prjemian prjemian deleted the 215-api-docs branch April 18, 2024 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rodolakis rodolakis Awaiting requested review from rodolakis

@MDecarabas MDecarabas Awaiting requested review from MDecarabas

Assignees

@prjemian prjemian

Labels
documentation Improvements or additions to documentation
Projects
GemViz initial release
Status: Done
Milestone
v1.0
Development

Successfully merging this pull request may close these issues.

start the API documentation
2 participants
@prjemian @rodolakis