Skip to content

add tutorial to documentation #42

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
Merged
merged 3 commits into from
Oct 28, 2024
Merged

add tutorial to documentation #42

merged 3 commits into from
Oct 28, 2024

Conversation

@cadenmyers13
Copy link
Contributor

No description provided.

sbillinge
sbillinge reviewed Oct 26, 2024
View reviewed changes
Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

I think tutorial is not part of the API so I am not sure what is going on here. Please can you post an image of the front page of the built docs and we can decide what it should look like

@cadenmyers13
Copy link
Contributor Author

cadenmyers13 commented Oct 27, 2024 •
edited
Loading

I think tutorial is not part of the API so I am not sure what is going on here. Please can you post an image of the front page of the built docs and we can decide what it should look like

I copied the format from pdfgui. Here's a screenshot of index.html from both. My commit message is incorrect, so sorry about that.

Screenshot 2024-10-27 at 3 57 53 PM Screenshot 2024-10-27 at 4 00 02 PM

@sbillinge
Copy link
Contributor

ok, this looks good. I would just put it above the license and release notes, as it is in PDFgui. Then I can merge it.

@cadenmyers13
Copy link
Contributor Author

@sbillinge done

@cadenmyers13 cadenmyers13 changed the title add tutorial to API add tutorial to documentation Oct 28, 2024
@sbillinge sbillinge merged commit 24f611c into diffpy:main Oct 28, 2024
3 checks passed
@cadenmyers13 cadenmyers13 deleted the api branch October 30, 2024 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sbillinge sbillinge sbillinge left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cadenmyers13 @sbillinge