Skip to content

Cookiecutter: add news and fix conf.py and liense.rst in doc#62

Merged
sbillinge merged 11 commits intodiffpy:cookiefrom
bobleesj:sign-off
Aug 11, 2024
Merged

Cookiecutter: add news and fix conf.py and liense.rst in doc#62
sbillinge merged 11 commits intodiffpy:cookiefrom
bobleesj:sign-off

Conversation

@bobleesj
Copy link
Copy Markdown
Contributor

@bobleesj bobleesj commented Aug 10, 2024

Screenshot 2024-08-09 at 8 27 02 PM

Should it be now merged to main so that I host the doc online? @sbillinge

I will continue standardizing and editing/removing files.

Not sure why I need your approval to run 2 workflows in this PR below?

Screenshot 2024-08-09 at 8 35 22 PM

@bobleesj bobleesj marked this pull request as ready for review August 10, 2024 00:38
Copy link
Copy Markdown
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

this looks good. Please see the inline comments.

Comment thread doc/source/conf.py Outdated
Comment thread doc/source/conf.py Outdated
Comment thread doc/source/license.rst Outdated

For more information please visit the diffpy web-page at
http://diffpy.org or email Prof. Simon Billinge at sb2896@columbia.edu.
Copyright (c) {% now 'utc', '%Y' %}, The Trustees of Columbia University in
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

add earlier begin date and make sure it is consistent between the readme and here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Screenshot 2024-08-10 at 7 16 54 PM

Added 2009 (earlier date) to where we have copyright

Comment thread news/cookie.rst
@sbillinge
Copy link
Copy Markdown
Contributor

@bobleesj please can you update the toml. I think this is not 5 in development but more like 3 or 4

Copy link
Copy Markdown
Contributor Author

@bobleesj bobleesj left a comment

Choose a reason for hiding this comment

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

@sbillinge Please review

  • Properly rename to diffpy.snmf in conf.py
  • Fix toml - fixed dev status from 5 to 4
  • Add code linting in news
  • Add Python support in news
  • Add earlier year to current year ex) 2009-2024 in copyright
  • doc locally running

In the following PR, I want to try hosting the doc via GH Pages. Does it need to be merged to main? I will continue to check any bad files by cross-checking with signed-off repos.

Comment thread pyproject.toml
Comment thread doc/source/conf.py
Comment thread doc/source/license.rst Outdated
Comment thread news/cookie.rst
Copy link
Copy Markdown
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

Just one last thing. I am guessing the work started no earlier than 2017 or so and possibly later so we don't want copyright statements going back to 2009?

Comment thread doc/source/license.rst Outdated
@bobleesj
Copy link
Copy Markdown
Contributor Author

From main, I found 2009 from doc/source/license.rst:

https://github.com/diffpy/diffpy.snmf/blob/main/doc/source/license.rst

Perhaps it's referring to the entire DiffPy project?

LICENSE has 2023:

https://github.com/diffpy/diffpy.snmf/blob/main/LICENSE

@bobleesj
Copy link
Copy Markdown
Contributor Author

I see your first commit in 2023:

ab17139

Would it be 2023 then? @sbillinge

Copy link
Copy Markdown
Contributor Author

@bobleesj bobleesj left a comment

Choose a reason for hiding this comment

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

Reviewed - now 2023-2024.

Comment thread doc/source/license.rst
@sbillinge sbillinge merged commit 90b559c into diffpy:cookie Aug 11, 2024
@bobleesj bobleesj deleted the sign-off branch August 11, 2024 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants