Skip to content

style: change documentation #33

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

Merged
sbillinge merged 7 commits into from
Oct 24, 2025
Merged

style: change documentation #33

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
daea939
style: remove ununcessary part in index.rst
stevenhua0320 Oct 23, 2025
7dfc631
chore: change author in index.rst
stevenhua0320 Oct 23, 2025
e10a83a
chore: add news item
stevenhua0320 Oct 23, 2025
85f3093
fix: change python version coverage to pass the CI build test
stevenhua0320 Oct 23, 2025
19364fc
style: change documentation for getting started.
stevenhua0320 Oct 23, 2025
146b74f
style: revert the change to compatible py version back to 3.11-3.13
stevenhua0320 Oct 23, 2025
f1fa6b6
style: change news item to right file.
stevenhua0320 Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ Getting started

Welcome to the ``diffpy.srxplanargui`` documentation!

@sbillinge sbillinge Oct 23, 2025

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.

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"


To get started, please visit the :ref:`Getting started <getting-started>` page.
This package is not designed to be run on its own. Please visit https://www.diffpy.org/products/xPDFsuite.html
for getting the whole xpdfsuite package and download the package there.

=======
Authors
=======

``diffpy.srxplanargui`` is developed by Rundong Hua, Simon Billinge, Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see
``diffpy.srxplanargui`` is developed by Xiaohao Yang, Simon Billinge, Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see
https://github.com/diffpy/diffpy.srxplanargui/graphs/contributors.

============
Expand Down
2 changes: 1 addition & 1 deletion news/TEMPLATE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

**Fixed:**

* <news item>
* Change documentation for diffpy.srxplanargui to successfully display.

@zmx27 zmx27 Oct 24, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think you may be accidentally modifying the template file

@sbillinge sbillinge Oct 24, 2025

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.

@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

@stevenhua0320 stevenhua0320 Oct 24, 2025

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 2025-10-23 at 9 03 58 PM

@stevenhua0320 stevenhua0320 Oct 24, 2025 •
edited
Loading

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.

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


**Security:**

Expand Down
Empty file added news/index.rst
View file
Open in desktop
Empty file.
Loading