Skip to content

skpkg: migrate documentation, README, and public static files#283

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
sbillinge merged 12 commits into from
Jun 11, 2025
Merged

skpkg: migrate documentation, README, and public static files #283

sbillinge merged 12 commits into from
Jun 11, 2025

Conversation

@ycexiao
Copy link
Contributor

@ycexiaoycexiao commented Jun 10, 2025

No description provided.

@codecov
Copy link

codecovbot commented Jun 10, 2025•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.10%. Comparing base (a4582ee) to head (daf5c8b).
Report is 8 commits behind head on migration.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ycexiaoycexiao marked this pull request as ready for review June 10, 2025 20:51
@ycexiao
Copy link
ContributorAuthor

ycexiao commented Jun 10, 2025

@sbillinge , it's ready for review.

sbillinge
sbillinge reviewed Jun 10, 2025
View reviewed changes
Copy link
Contributor

@sbillingesbillinge left a comment

Choose a reason for hiding this comment

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

please bring over license.rst and index.rst from the old packages without changes. Then also address my comments. Thx

doc/source/index.rst Outdated
.. |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.
Copy link
Contributor

@sbillingesbillingeJun 10, 2025

Choose a reason for hiding this comment

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

add "the" in here too

doc/source/index.rst
| Last updated |today|
| Last updated |today|.

For users who do not have the expertise or necessity for command
Copy link
Contributor

@sbillingesbillingeJun 10, 2025

Choose a reason for hiding this comment

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

keep this

sbillinge
sbillinge reviewed Jun 10, 2025
View reviewed changes
Copy link
Contributor

@sbillingesbillinge left a comment

Choose a reason for hiding this comment

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

just a few more comments.

doc/source/getting-started.rst Outdated
@@ -0,0 +1,79 @@
:tocdepth: -1
Copy link
Contributor

@sbillingesbillingeJun 10, 2025

Choose a reason for hiding this comment

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

this entire file needs to be deleted. There is pdfgui documentation so we don't need this stub. Also the skpkg logo

doc/source/snippets/example-table.rst Outdated
@@ -0,0 +1,28 @@
.. list-table:: 5 levels of reusing/sharing code
Copy link
Contributor

@sbillingesbillingeJun 10, 2025

Choose a reason for hiding this comment

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

this example doc file also should be deleted

@ycexiao
Copy link
ContributorAuthor

ycexiao commented Jun 10, 2025

@sbillinge , it's ready for review.

sbillinge
sbillinge reviewed Jun 11, 2025
View reviewed changes
Copy link
Contributor

@sbillingesbillinge left a comment

Choose a reason for hiding this comment

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

nearly there...I caught one last thing.

doc/source/api/diffpy.pdfgui.example_package.rst Outdated
@@ -0,0 +1,31 @@
.. _example_package documentation:
Copy link
Contributor

@sbillingesbillingeJun 11, 2025

Choose a reason for hiding this comment

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

@ycexiao sorry I missed this stub file too. This needs to be deleted.

@ycexiao
Copy link
ContributorAuthor

ycexiao commented Jun 11, 2025

@sbillinge , it's ready for review.

@sbillingesbillinge merged commit 4af7868 into diffpy:migrationJun 11, 2025
4 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sbillingesbillingesbillinge 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

@ycexiao@sbillinge