skpkg: migrate documentation, README, and public static files #153
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## migration #153 +/- ##
============================================
Coverage ? 91.96%
============================================
Files ? 7
Lines ? 112
Branches ? 0
============================================
Hits ? 103
Misses ? 9
Partials ? 0 🚀 New features to boost your workflow:
|
| @@ -1,91 +1,56 @@ | |||
| Welcome to SNMF's Documentation! | |||
There was a problem hiding this comment.
here also, just move the old file over to the new proejct so wee keep everything. I don't think there is anything we need from the new template.
| Authors | ||
| ------- | ||
| ======= |
There was a problem hiding this comment.
maybe make this change after you move over the old file
| Indices | ||
| ------- | ||
| ======= |
|
|
||
| To get started, please go to :ref:`quick_start` | ||
| ================ |
There was a problem hiding this comment.
and add this Acknowledgements section to the new doc.
doc/source/license.rst
Outdated
| @@ -9,8 +9,7 @@ OPEN SOURCE LICENSE AGREEMENT | |||
| ============================= | |||
| BSD 3-Clause License | |||
|
|
|||
| Copyright (c) 2023-2024, The Trustees of Columbia University in | |||
| the City of New York. | |||
| Copyright (c) 2025, The Trustees of Columbia University in the City of New York. | |||
|
@sbillinge what do you mean by this? I think that this is the only time I added the news file mentioning that this is now at level 5 skpkg standard.
Other than that, this is ready for review. |
|
great work! Nicely done there. |
|
@sbillinge I just checked everything over and I think the migration of this package is finished. Please make a PR to merge the migration branch into main and close #147! |
|
Please expand s bit on "I think it is..." What tests did you do and how did they turn out? |
|
I have checked that there are no issues with any of the files we migrated, and all of the tests passes when running |
Thanks. This is what I need. This is much more informational than saying "I think it is ok". @bobleesj sometimes pastes a screenshot of the passing tests which is confidence inspiring. Not for |
* skpkg: setup CI after migrating tests, src, requirements, and .github folder (#151) * skpkg: migrate src folder * skpkg: migrate tests folder * skpkg: list dependencies in requirements folder * skpkg: add CI and issue/PR templates * skpkg: add pyproject.toml * skpkg: standardize files by removing examples and adding back necessary scripts * skpkg: modify copyright years and contributors in a missed file * style: changed line length to 115 and ran pre-commit again * fix: testing if adding .github/workflow will pass CI * [pre-commit.ci] auto fixes from pre-commit hooks --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * skpkg: add configuration files for pre-commit, readthedocs, codecov (#152) * skpkg: add config files for pre-commit * skpkg: add config files readthedocs, codecov, GitHub * style: remove stashed change indicators and modify code of conducts to pass pre-commit * skpkg: migrate documentation, README, and public static files (#153) * skpkg: migrate documentation * skpkg: add config files for authors, changelog, code of conduct, license * skpkg: add README.rst * skpkg: add news files * chore: add back necessary lines from the files * chore: fix files according to comments in the review --------- Co-authored-by: zmx27 <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
No description provided.