Skip to content

Commit d9ed7fc

Browse files
authored
Merge pull request #33 from stevenhua0320/main
style: change documentation
2 parents d76200f + f1fa6b6 commit d9ed7fc

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

docs/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ Getting started
1515

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

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

2021
=======
2122
Authors
2223
=======
2324

24-
``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
25+
``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
2526
https://github.com/diffpy/diffpy.srxplanargui/graphs/contributors.
2627

2728
============

news/index.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* <news item>
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* Change documentation for diffpy.srxplanargui to successfully display.
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)