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

incorporate manual into deploying docs #198

Merged
merged 1 commit into from
Aug 23, 2024
Merged

Conversation

Tieqiong
Copy link
Contributor

Also see #177

Now user guide (or often referred to manual) is merged into the cookiecutter api document and will be deployed with a certain url. Resources used in manual and tutorial will also be deployed.

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.

This looks fine, but I see a bunch of doc/tutorial files simply deleted. What is the plan for these?

@Tieqiong
Copy link
Contributor Author

So I guess when people follows the manual or tutorial it's easier for them to download resources for each section instead of individual resources, file by file (there are data series for one fit that people might have to download ~15 individual files for one example)

I compressed the doc/tutorial files by section as zip and put them in doc/source/manual_resources. You can check the name and see if we want to refine any of them.

@sbillinge
Copy link
Contributor

So I guess when people follows the manual or tutorial it's easier for them to download resources for each section instead of individual resources, file by file (there are data series for one fit that people might have to download ~15 individual files for one example)

I compressed the doc/tutorial files by section as zip and put them in doc/source/manual_resources. You can check the name and see if we want to refine any of them.

Ok, that makes sense. When you make decisions like that, please start a comment chain so it can be discussed. In general more discussion of what you are doing and why would be helpful in your PRs

@sbillinge sbillinge merged commit 6497698 into diffpy:main Aug 23, 2024
2 checks passed
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.

2 participants