FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

incorporate manual into deploying docs by Tieqiong · Pull Request #198 · diffpy/diffpy.pdfgui · GitHub

Repository navigation

incorporate manual into deploying docs - #198

Merged
sbillinge merged 1 commit into
diffpy:mainfrom
Tieqiong:document
Aug 23, 2024
Merged

sbillinge merged 1 commit into
diffpy:mainfrom
Tieqiong:document

Conversation

Copy link
Copy Markdown
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.

sbillinge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Copy link
Copy Markdown
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.

Copy link
Copy Markdown
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 merged commit 6497698 into diffpy:main Aug 23, 2024
Tieqiong deleted the document branch December 21, 2024 02:52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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


Back | FazBrowse Home | New Git URL