style: change documentation #33
Conversation
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
Please see comments. Let's do the next release not in 3.14, so leave the pyproject.toml unchanged for now.
| Getting started | ||
| =============== | ||
|
|
||
| Welcome to the ``diffpy.srxplanargui`` documentation! |
There was a problem hiding this comment.
Let's not delete this section, but change the second sentence to "This package is not designed to be run on its own. Please visit..." and describe how to get started with xPDFsuite"
zmx27
left a comment
zmx27
left a comment
There was a problem hiding this comment.
@stevenhua0320 I think you can get tests to pass by explicitly setting the python_version to 3.13 instead of the default 3.14 from the workflow file that is being called
news/TEMPLATE.rst
Outdated
| **Fixed:** | ||
|
|
||
| * <news item> | ||
| * Change documentation for diffpy.srxplanargui to successfully display. |
There was a problem hiding this comment.
I think you may be accidentally modifying the template file
There was a problem hiding this comment.
@stevenhua0320 as well as fixing this, please can you also paste the results of running pytest in a 3.13 env on your local, and I will merge this even when it is failing CI
There was a problem hiding this comment.
@sbillinge This is the pytest I recently run after I made the edits on news
(diffpy.srxplanargui-env) ~/dbs/diffpy.srxplanargui/diffpy.srxplanargui git:[main]
pytest
===================================================================== test session starts ======================================================================
platform darwin -- Python 3.13.9, pytest-8.4.2, pluggy-1.6.0
rootdir: /Users/huarundong/dbs/diffpy.srxplanargui/diffpy.srxplanargui
configfile: pyproject.toml
plugins: env-1.2.0, cov-7.0.0
collected 1 item
tests/test_version.py . [100%]
====================================================================== 1 passed in 0.03s =======================================================================
3 participants
@sbillinge Ready to review, but since this is a private repo for now and there is no doc in old version of this package, the documentation should be very simple page with no other info.
