skpkg: migrate documentation, README, and public static files #283
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## migration #283 +/- ##
==========================================
Coverage 95.10% 95.10%
==========================================
Files 23 23
Lines 1123 1123
==========================================
Hits 1068 1068
Misses 55 55 🚀 New features to boost your workflow:
|
|
@sbillinge , it's ready for review. |
sbillinge
reviewed
Jun 10, 2025
doc/source/index.rst
Outdated
| @@ -4,94 +4,49 @@ | |||
|
|
|||
| .. |title| replace:: diffpy.pdfgui documentation | |||
|
|
|||
| diffpy.pdfgui - GUI for PDF simulation and structure refinement. | |||
| ``diffpy.pdfgui`` - Graphical user interface program for structure refinements to atomic pair distribution function. | |||
doc/source/index.rst
Outdated
|
|
||
| For users who do not have the expertise or necessity for command |
sbillinge
reviewed
Jun 10, 2025
doc/source/getting-started.rst
Outdated
| @@ -0,0 +1,79 @@ | |||
| :tocdepth: -1 | |||
There was a problem hiding this comment.
this entire file needs to be deleted. There is pdfgui documentation so we don't need this stub. Also the skpkg logo
| @@ -0,0 +1,28 @@ | |||
| .. list-table:: 5 levels of reusing/sharing code | |||
There was a problem hiding this comment.
this example doc file also should be deleted
|
@sbillinge , it's ready for review. |
sbillinge
reviewed
Jun 11, 2025
| @@ -0,0 +1,31 @@ | |||
| .. _example_package documentation: | |||
There was a problem hiding this comment.
@ycexiao sorry I missed this stub file too. This needs to be deleted.
|
@sbillinge , it's ready for review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.