skpkg: migrate docs/source files #24
Conversation
| @@ -1,14 +1,14 @@ | |||
| INFO: Number of function calls = 7 | |||
There was a problem hiding this comment.
There seems to be an issue with the cp command that you likely ran. We would like these files to remain in the examples folder, not directly under the docs directory
docs/source/conf.py
Outdated
|
|
||
| # abbreviations | ||
| ab_authors = "Xiaohao Yang, Simon J.L. Billinge group" | ||
| ab_authors = "Simon Billinge, Billinge Group members" |
There was a problem hiding this comment.
Change back to Xiaohao Yang, Billinge Group members
docs/source/index.rst
Outdated
|
|
||
| .. |title| replace:: diffpy.srxplanar documentation | ||
|
|
||
| ``diffpy.srxplanar`` - Distance Printer, calculate the inter atomic distances. Part of xPDFsuite |
docs/source/index.rst
Outdated
|
|
||
| Welcome to the ``diffpy.srxplanar`` documentation! | ||
|
|
||
| To get started, please visit the :ref:`Getting started <getting-started>` page. |
There was a problem hiding this comment.
It seems like you deleted the getting-started.rst file, so you should probably delete this section too. Alternatively, you can also add back that file and write some lightweight information about the package in it if you want
docs/source/index.rst
Outdated
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| getting-started |
There was a problem hiding this comment.
If you're not going to have this file, remove
docs/source/index.rst
Outdated
|
|
||
| Xiaohao Yang, Pavol Juhas, Simon J. L. Billinge, On the estimation of | ||
| statistical uncertainties on powder diffraction and small angle | ||
| scattering data from 2-D x-ray detectors, arXiv:1309.3614 |
There was a problem hiding this comment.
I would suggest putting this information somewhere other than the Acknowledgements section
docs/source/index.rst
Outdated
| Authors | ||
| ======= | ||
|
|
||
| ``diffpy.srxplanar`` is developed by Simon Billinge, Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see |
There was a problem hiding this comment.
developed by Xiaohao Yang and Billinge Group members maybe, but maintainer is still Professor Simon
docs/source/license.rst
Outdated
| ============================= | ||
| BSD 3-Clause License | ||
|
|
||
| Copyright (c) 2025, The Trustees of Columbia University in the City of New York. |
There was a problem hiding this comment.
I'm not sure if we will be going with this license or staying with the old one, so let's ask. Regardless, a quick lookup in the repo tells me that this should probably be 2008-2025?
|
| @@ -0,0 +1,46 @@ | |||
| ####### | |||
There was a problem hiding this comment.
Please keep the part from the old index.rst file starting with diffpy.srxplanar package provides 2D diffraction image integration using non splitting pixel algorithm...
|
@sbillinge Ready to review |
There was a problem hiding this comment.
this looks good. I thnk we normally like to put the data files in docs/examples/data. Can the examples be made to work with this arrangement or the data have to be in the same directory?
Does SrxPlanar have a BSD license? If so that's great, just please double-check in the original.
Let me try for the data files in |
3 participants
@zmx27 Ready to review