Skip to content

Commit c1e94a1

Browse files
committed
docs: add index.rst to allow docs to build, fix rendering issues in readme
1 parent 46ff20f commit c1e94a1

File tree

2 files changed

+61
-4
lines changed

2 files changed

+61
-4
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,28 +44,28 @@ Independent Installation
4444
------------------------
4545
You can also install ``diffpy.distanceprinter`` independently for yourself.
4646

47-
Assuming you have a wheel file in the current working directory, in an active conda environment please type
47+
Assuming you have a wheel file in the current working directory, in an active conda environment please type ::
4848

4949
pip install ./diffpy.distanceprinter-VERSION.whl
5050

5151
where you replace VERSION with the actual version you have so the command matches the filename of the
5252
wheel file you have.
5353

54-
The commands to create and activate the conda environment with name "distanceprinter-env" is
54+
The commands to create and activate the conda environment with name "distanceprinter-env" is ::
5555

5656
conda create -n distanceprinter-env python=3.13
5757
conda activate distanceprinter-env
5858

5959
If you don't have conda installed, we recomment you install `miniconda
6060
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
61-
To install this software from a Python wheel distribution format execute
61+
To install this software from a Python wheel distribution format execute ::
6262

6363
pip install ./diffpy.distanceprinter-VERSION.whl
6464

6565
If you are a developer, you can also install this package from sources. First, obtain the source archive
6666
from `GitHub <https://github.com/diffpy/diffpy.distanceprinter/>`_.
6767
Install the packages in ``./requirements/conda.txt`` and ``./requirements/tests.txt``
68-
using the `--file`` command:
68+
using the ``--file`` command ::
6969

7070
conda activate distanceprinter-env
7171
conda install --file ./requirements/conda.txt

docs/source/index.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
#######
2+
|title|
3+
#######
4+
5+
.. |title| replace:: diffpy.distanceprinter documentation
6+
7+
``diffpy.distanceprinter`` - Distance Printer, calculate the inter atomic distances. Part of xPDFsuite.
8+
9+
| Software version |release|
10+
| Last updated |today|.
11+
12+
===============
13+
Getting started
14+
===============
15+
16+
Welcome to the ``diffpy.distanceprinter`` documentation!
17+
18+
This package is not designed to be installed independently. To get started, please visit
19+
https://www.diffpy.org/products/xPDFsuite.html for more information about the xpdfsuite package and
20+
download the package together with ``diffpy.xpdfsuite``.
21+
22+
=======
23+
Authors
24+
=======
25+
26+
``diffpy.distanceprinter`` is developed by Xiaohao Yang and Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see
27+
https://github.com/diffpy/diffpy.distanceprinter/graphs/contributors.
28+
29+
============
30+
Installation
31+
============
32+
33+
See the `README <https://github.com/diffpy/diffpy.distanceprinter#installation>`_
34+
file included with the distribution.
35+
36+
================
37+
Acknowledgements
38+
================
39+
40+
``diffpy.distanceprinter`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
41+
42+
=================
43+
Table of contents
44+
=================
45+
.. toctree::
46+
:maxdepth: 2
47+
48+
Package API <api/diffpy.distanceprinter>
49+
release
50+
license
51+
52+
=======
53+
Indices
54+
=======
55+
56+
* :ref:`genindex`
57+
* :ref:`search`

0 commit comments

Comments
 (0)