Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Pdfmorph web-page #23
base: source
Are you sure you want to change the base?
Pdfmorph web-page #23
Changes from 5 commits
3cd884f
59c2995
726a7b1
27a78fc
b05ea1a
afcd519
92d28ed
87f5b62
46364ae
9b51ea7
9408726
2300e7c
d87c500
1ee2756
13435df
aaa81dd
4bc49b4
612a7b9
76f0294
54417fd
ea9dcec
13c79ea
02628b0
e5bccef
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sbillinge I shortened the description a little bit here - please let me know if it's too detrimental to the content itself!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is good. Make sure there is a pointer to the user manual documentation
btw, please make an issue to check all the docstrings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no manual in the diffpy.pdfmorph master, so I assume I'll have to link that once I make it, right? and will do on the docstrings issue! Would that be for this particular PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
package specific doc should go to diffpy.pdfmorph repo in a different PR.
You will need to create a special branch named `gh-pages so github will build the website for you automatically. We can talk about more details in person.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good! I'll grab you when you come back
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually the best would be to publish package docs on readthedocs.io, for example the docs for diffpy.structure are at https://diffpystructure.readthedocs.io/en/stable.
I have a TODO issue #22 to stop hosting manual at the gh-pages branch and move it over to RTD. This should eventually happen for all diffpy packages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll get started on that! Thank you @pavoljuhas. So publishing on rtd is what we would want to do for the documentation for all of diffpy? Sounds like a decent project!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think it would save a lot of work and keep the manuals in sync with the source code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pavoljuhas would you mind providing the source for the diffpy.structure that was published on readthedocs? That would be really helpful, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The RTD page is rebuild on pushes to https://github.com/diffpy/diffpy.structure repo with the manual sources in
doc/manual
. There is a small control file .readthedocs.yml to setup the manual compilation at RTD.Setting up an RTD build for PDFmorph should be an issue in the pdfmorph project.
Here we should create documentation links pointing to the RTD pages - once they are up.