skpkg: migrate documentation, README, and public static files #204
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## migration #204 +/- ##
==========================================
Coverage 97.23% 97.23%
==========================================
Files 20 20
Lines 903 903
==========================================
Hits 878 878
Misses 25 25 🚀 New features to boost your workflow:
|
|
@sbillinge I said I would redo this in another branch but ended up not doing that because I realized that pulling from upstream in a new branch undid all of the changes that How should I deal with these? Other than that, ready for review. |
There was a problem hiding this comment.
OK, so the example doc files need to be removed (this is why we would like package update public, so I don't have to write this review message!).
Also the index.rst needs to be properly merged from the original.
When you do those things I can merge this and we can work on the large files.
For any pdf or image files we might want to investigate why they are large and look for ways to compress them. It is not hte end of the world that they are big but it makes things harder for people with slow internet connections! I think there is an example dataset or two in there too. We could fight with making them smaller, but it is probably not worth it so we wlil just merge those. I can do that.
|
@sbillinge this is ready for review after addressing your concerns. I will make another PR once this is merged with my best attempt at compressing the large files |
README.rst
Outdated
|
|
||
| If the above does not work, you can use ``pip`` to download and install the latest release from | ||
| `Python Package Index <https://pypi.python.org>`_. | ||
| To install using ``pip`` into your ``diffpy.morph_env`` environment, we will also have to install dependencies :: |
There was a problem hiding this comment.
I think we shouldn't remove this block. In general, we don't want to remove things coming from the old package, unless it is something that is modified/improved in the new package.
LICENSE.rst
Outdated
| @@ -1,7 +1,6 @@ | |||
| BSD 3-Clause License | |||
|
|
|||
| Copyright (c) 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. | |||
There was a problem hiding this comment.
I think we need this to be 2024-2025
README.rst
Outdated
| pip install -r https://raw.githubusercontent.com/diffpy/diffpy.morph/main/requirements/pip.txt | ||
|
|
||
| and then install the package :: | ||
| To install using ``pip`` into your ``diffpy.morph_env`` environment, type :: |
There was a problem hiding this comment.
remove this if we keep the block before.
doc/source/getting-started.rst
Outdated
| @@ -0,0 +1,79 @@ | |||
| :tocdepth: -1 | |||
There was a problem hiding this comment.
this is a template example file we want to remove it. Also the skpkg image below. This is one reason I want the package update public
| @@ -1,10 +1,12 @@ | |||
| ############################################# | |||
doc/source/license.rst
Outdated
| @@ -9,8 +9,7 @@ OPEN SOURCE LICENSE AGREEMENT | |||
| ============================= | |||
| BSD 3-Clause License | |||
|
|
|||
| Copyright (c) 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 ready for review |
|
phew, that was a lot of work..... We just need the large files worked on. |
No description provided.