Skip to content

Commit 877d440

Browse files
pavoljuhaspavoljuhas
committed
Merge branch 'use-structure-manual-on-rtd' into source
* use diffpy.structure manual at readthedocs.io * use https URLs where available * use single definition for external documentation * use single definition for major GitHub links * use lowercase for `diffpy.structure` name Resolve #22.
2 parents c9c63c0 + cb53b14 commit 877d440

File tree

16 files changed

+86
-107
lines changed

16 files changed

+86
-107
lines changed

Diff for: ‎abbreviations.txt

+21
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,27 @@
77
.. _diffpy-users: https://groups.google.com/d/forum/diffpy-users
88
.. _ctv-xpdfsuite: http://innovation.columbia.edu/technologies/m11-120
99

10+
.. GitHub repositories -------------------------------------------------
11+
12+
.. _diffpy.mpdf: https://github.com/benfrandsen/diffpy.magpdf
13+
.. _diffpy.srfit: https://github.com/diffpy/diffpy.srfit
14+
.. _diffpy.srreal: https://github.com/diffpy/diffpy.srreal
15+
.. _diffpy.structure: https://github.com/diffpy/diffpy.structure
16+
.. _diffpy.utils: https://github.com/diffpy/diffpy.utils
17+
.. _libdiffpy: https://github.com/diffpy/libdiffpy
18+
.. _libobjcryst: https://github.com/diffpy/libobjcryst
19+
.. _pyobjcryst: https://github.com/diffpy/pyobjcryst
20+
.. _srfit-sasview: https://github.com/diffpy/srfit-sasview
21+
22+
.. External online documentation ---------------------------------------
23+
24+
.. _doc-diffpy.srfit: https://diffpy.github.io/diffpy.srfit
25+
.. _doc-diffpy.srreal: https://diffpy.github.io/diffpy.srreal
26+
.. _doc-diffpy.structure: https://diffpystructure.readthedocs.io
27+
.. _doc-diffpy.utils: https://diffpy.github.io/diffpy.utils
28+
.. _doc-libdiffpy: https://diffpy.github.io/libdiffpy
29+
.. _doc-pyobjcryst: https://diffpy.github.io/pyobjcryst
30+
1031
.. Citations -----------------------------------------------------------
1132
1233
.. |citeJuhasJac13| replace::

Diff for: ‎products/SrMise.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ What next?
180180
============
181181

182182
Explore the SrMise
183-
`tutorial <http://diffpy.github.io/diffpy.srmise/tutorial/index.html>`_!
183+
`tutorial <https://diffpy.github.io/diffpy.srmise/tutorial/index.html>`_!
184184

185185
.. toctree::
186186
:hidden:

Diff for: ‎products/diffpycmi/contents.rst

+18-17
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,29 @@ Libraries developed by the DiffPy team
1818
- Description
1919

2020
* - `diffpy.srfit`_
21-
- `doc <../../doc/srfit>`__
21+
- |doc-diffpy.srfit|_
2222
- Setup and control of general fitting problems.
2323

2424
* - `diffpy.srreal`_
25-
- `doc <../../doc/srreal/>`__
25+
- |doc-diffpy.srreal|_
2626
- Python library for calculation of pair based quantities such as
2727
the pair distribution function (PDF), bond lengths, and bond
2828
valence sums.
2929

30-
* - `diffpy.Structure`_
31-
- `doc <../../doc/structure/>`__
30+
* - `diffpy.structure`_
31+
- |doc-diffpy.structure|_
3232
- Light-weigth storage of crystal structure data.
3333

3434
* - `diffpy.utils`_
35-
- `doc <../../doc/utils/>`__
35+
- |doc-diffpy.utils|_
3636
- General purpose utilities for the diffpy libraries.
3737

3838
* - `pyobjcryst`_
39-
- `doc <../../doc/pyobjcryst/>`__
39+
- |doc-pyobjcryst|_
4040
- Python bindings to the ObjCryst++ crystallographic library.
4141

4242
* - `libdiffpy`_
43-
- `doc <../../doc/libdiffpy/>`__
43+
- |doc-libdiffpy|_
4444
- C++ library for calculation of PDF and other real-space
4545
quantities.
4646

@@ -58,7 +58,7 @@ External libraries
5858
- Description
5959

6060
* - srfit-sasview_
61-
- `doc <http://www.sasview.org/docs/user/user.html>`__
61+
- `doc <https://www.sasview.org/docs/user/user.html>`__
6262
- Selected modules from SasView_, the Small
6363
Angle Scattering Analysis Software Package.
6464

@@ -78,14 +78,15 @@ External libraries
7878

7979
.. URL definitions below -----------------------------------------------
8080
81+
.. |doc-diffpy.srfit| replace:: doc
82+
.. |doc-diffpy.srreal| replace:: doc
83+
.. |doc-diffpy.structure| replace:: doc
84+
.. |doc-diffpy.utils| replace:: doc
85+
.. |doc-pyobjcryst| replace:: doc
86+
.. |doc-libdiffpy| replace:: doc
87+
8188
.. _cxxtest: http://cxxtest.com/
82-
.. _diffpy.Structure: https://github.com/diffpy/diffpy.structure
83-
.. _diffpy.srfit: https://github.com/diffpy/diffpy.srfit
84-
.. _diffpy.srreal: https://github.com/diffpy/diffpy.srreal
85-
.. _diffpy.utils: https://github.com/diffpy/diffpy.utils
86-
.. _libdiffpy: https://github.com/diffpy/libdiffpy
87-
.. _libobjcryst: https://github.com/diffpy/libobjcryst
8889
.. _periodictable: http://www.reflectometry.org/danse/elements.html
89-
.. _pyobjcryst: https://github.com/diffpy/pyobjcryst
90-
.. _srfit-sasview: https://github.com/diffpy/srfit-sasview
91-
.. _SasView: http://www.sasview.org/
90+
.. _SasView: https://www.sasview.org
91+
92+
.. include:: ../../abbreviations.txt

Diff for: ‎products/diffpycmi/contributecode.rst

+3-13
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Module Description
1616
function (PDF), bond lengths, and bond
1717
valence sums.
1818

19-
`diffpy.Structure`_ Handles storage of crystal structure data.
19+
`diffpy.structure`_ Handles storage of crystal structure data.
2020

2121
`diffpy.utils`_ General purpose shared utilities for the
2222
diffpy libraries.
@@ -32,16 +32,6 @@ Module Description
3232
as a shared library
3333
====================== ============================================
3434

35-
.. _diffpy.srfit: https://github.com/diffpy/diffpy.srfit
35+
.. URL definitions below -----------------------------------------------
3636

37-
.. _diffpy.srreal: https://github.com/diffpy/diffpy.srreal
38-
39-
.. _diffpy.Structure: https://github.com/diffpy/diffpy.structure
40-
41-
.. _diffpy.utils: https://github.com/diffpy/diffpy.utils
42-
43-
.. _pyobjcryst: https://github.com/diffpy/pyobjcryst
44-
45-
.. _libdiffpy: https://github.com/diffpy/libdiffpy
46-
47-
.. _libobjcryst: https://github.com/diffpy/libobjcryst
37+
.. include:: ../../abbreviations.txt

Diff for: ‎products/diffpycmi/index.rst

+15-19
Original file line numberDiff line numberDiff line change
@@ -92,30 +92,17 @@ Documentation
9292
Documentation for packages developed by the DiffPy team is available
9393
at the links below.
9494

95-
* diffpy.srfit_ -- configuration and control of data-fitting problems
96-
* diffpy.srreal_ -- calculators for pair distribution function, bond
95+
* |doc-diffpy.srfit|_ -- configuration and control of data-fitting problems
96+
* |doc-diffpy.srreal|_ -- calculators for pair distribution function, bond
9797
valence sums, etc.
98-
* diffpy.Structure_ -- light-weight representation of crystal
98+
* |doc-diffpy.structure|_ -- light-weight representation of crystal
9999
structures
100-
* pyobjcryst_ -- Python interface to ObjCryst++ crystallographic
100+
* |doc-pyobjcryst|_ -- Python interface to ObjCryst++ crystallographic
101101
library
102-
* diffpy.utils_ -- general purpose utilities for the diffpy libraries
103-
* libdiffpy_ -- C++ library for calculation of PDF and other real-space
102+
* |doc-diffpy.utils|_ -- general purpose utilities for the diffpy libraries
103+
* |doc-libdiffpy|_ -- C++ library for calculation of PDF and other real-space
104104
quantities
105105

106-
.. _diffpy.srfit: ../../doc/srfit/
107-
108-
.. _diffpy.srreal: ../../doc/srreal/
109-
110-
.. _diffpy.Structure: ../../doc/structure/
111-
112-
.. _diffpy.utils: ../../doc/utils/
113-
114-
.. _pyobjcryst: ../../doc/pyobjcryst/
115-
116-
.. _libdiffpy: ../../doc/libdiffpy/
117-
118-
119106
See :ref:`DiffPy-CMI contents <contents>` for a complete list
120107
of open-source libraries that are included in DiffPy-CMI and
121108
their respective project pages.
@@ -130,4 +117,13 @@ paper:
130117

131118
* |citeJuhasAca15|
132119

120+
.. URL definitions below -----------------------------------------------
121+
122+
.. |doc-diffpy.srfit| replace:: diffpy.srfit
123+
.. |doc-diffpy.srreal| replace:: diffpy.srreal
124+
.. |doc-diffpy.structure| replace:: diffpy.structure
125+
.. |doc-diffpy.utils| replace:: diffpy.utils
126+
.. |doc-pyobjcryst| replace:: pyobjcryst
127+
.. |doc-libdiffpy| replace:: libdiffpy
128+
133129
.. include:: ../../abbreviations.txt

Diff for: ‎products/mPDF.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The diffpy.mpdf package provides a convenient method for computing the magnetic
99
data. The mPDF is calculated by an MPDFcalculator object, which extracts the spin
1010
positions and spin vectors from a MagStructure object that the MPDFcalculator
1111
takes as input. The MagStructure object in turn can contain multiple MagSpecies
12-
objects, which generate magnetic configurations based on a diffpy.Structure object
12+
objects, which generate magnetic configurations based on a diffpy.structure object
1313
and a set of propagation vectors and basis vectors provided by the user.
1414
Alternatively, the user can manually define a magnetic unit cell that will be used
1515
to generate the magnetic structure, or the magnetic structure can be defined simply
@@ -33,7 +33,7 @@ The diffpy.mpdf package requires Python 2.6 or 2.7 and the following software:
3333
* ``NumPy`` - numerical mathematics and fast array operations for Python
3434
* ``SciPy`` - scientific libraries for Python
3535
* ``matplotlib`` - python plotting library
36-
* ``diffpy.Structure`` - diffpy package for generating atomic structure
36+
* ``diffpy.structure`` - diffpy package for generating atomic structure
3737
* ``diffpy.srreal`` - diffpy package for calculating real-space quantities
3838

3939
See the :doc:`mpdf license <mPDFlicense>` for terms and conditions of use.

Diff for: ‎products/pythonpackages.rst

+2-13
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Module Description
2222
function (PDF), bond lengths, and bond
2323
valence sums.
2424

25-
`diffpy.Structure`_ Handles storage of crystal structure data.
25+
`diffpy.structure`_ Handles storage of crystal structure data.
2626

2727
`diffpy.utils`_ General purpose shared utilities for the
2828
diffpy libraries.
@@ -39,20 +39,9 @@ Module Description
3939
PDFs.
4040
====================== ============================================
4141

42-
.. _diffpy.srfit: https://github.com/diffpy/diffpy.srfit
42+
.. URL definitions below -----------------------------------------------
4343

4444
.. _diffpy.srmise: https://github.com/diffpy/diffpy.srmise
45-
46-
.. _diffpy.srreal: https://github.com/diffpy/diffpy.srreal
47-
48-
.. _diffpy.Structure: https://github.com/diffpy/diffpy.structure
49-
50-
.. _diffpy.utils: https://github.com/diffpy/diffpy.utils
51-
52-
.. _pyobjcryst: https://github.com/diffpy/pyobjcryst
53-
5445
.. _diffpy.pdffit2: https://github.com/diffpy/diffpy.pdffit2
5546

56-
.. _diffpy.mpdf: https://github.com/benfrandsen/diffpy.magpdf
57-
5847
.. include:: ../abbreviations.txt

Diff for: ‎static_root/diffpy.Structure/index.html

-18
This file was deleted.

Diff for: ‎static_root/doc/libdiffpy/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/libdiffpy/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/libdiffpy/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/libdiffpy/"
7+
window.location.href = "https://diffpy.github.io/libdiffpy/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
13-
If you are not redirected automatically, follow the <a href='http://diffpy.github.io/libdiffpy/'>link</a>
13+
If you are not redirected automatically, follow the <a href='https://diffpy.github.io/libdiffpy/'>link</a>

Diff for: ‎static_root/doc/pyobjcryst/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/pyobjcryst/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/pyobjcryst/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/pyobjcryst/"
7+
window.location.href = "https://diffpy.github.io/pyobjcryst/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
13-
If you are not redirected automatically, follow the <a href='http://diffpy.github.io/pyobjcryst/'>link</a>
13+
If you are not redirected automatically, follow the <a href='https://diffpy.github.io/pyobjcryst/'>link</a>

Diff for: ‎static_root/doc/srfit/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/diffpy.srfit/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/diffpy.srfit/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/diffpy.srfit/"
7+
window.location.href = "https://diffpy.github.io/diffpy.srfit/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link,
1313
just tell them that it is a link. -->
1414
If you are not redirected automatically, follow the
15-
<a href='http://diffpy.github.io/diffpy.srfit/'>link</a>.
15+
<a href='https://diffpy.github.io/diffpy.srfit/'>link</a>.

Diff for: ‎static_root/doc/srmise/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/diffpy.srmise/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/diffpy.srmise/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/diffpy.srmise/"
7+
window.location.href = "https://diffpy.github.io/diffpy.srmise/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link,
1313
just tell them that it is a link. -->
1414
If you are not redirected automatically, follow the
15-
<a href='http://diffpy.github.io/diffpy.srmise/'>link</a>.
15+
<a href='https://diffpy.github.io/diffpy.srmise/'>link</a>.

Diff for: ‎static_root/doc/srreal/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/diffpy.srreal/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/diffpy.srreal/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/diffpy.srreal/"
7+
window.location.href = "https://diffpy.github.io/diffpy.srreal/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
13-
If you are not redirected automatically, follow the <a href='http://diffpy.github.io/diffpy.srreal/'>link</a>
13+
If you are not redirected automatically, follow the <a href='https://diffpy.github.io/diffpy.srreal/'>link</a>

Diff for: ‎static_root/doc/srxplanar/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/diffpy.srxplanar/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/diffpy.srxplanar/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/diffpy.srxplanar/"
7+
window.location.href = "https://diffpy.github.io/diffpy.srxplanar/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link,
1313
just tell them that it is a link. -->
1414
If you are not redirected automatically, follow the
15-
<a href='http://diffpy.github.io/diffpy.srxplanar/'>link</a>.
15+
<a href='https://diffpy.github.io/diffpy.srxplanar/'>link</a>.

Diff for: ‎static_root/doc/structure/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/diffpy.structure/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpystructure.readthedocs.io">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/diffpy.structure/"
7+
window.location.href = "https://diffpystructure.readthedocs.io"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link,
1313
just tell them that it is a link. -->
1414
If you are not redirected automatically, follow the
15-
<a href='http://diffpy.github.io/diffpy.structure/'>link</a>.
15+
<a href="https://diffpystructure.readthedocs.io">link</a>.

Diff for: ‎static_root/doc/utils/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!DOCTYPE HTML>
22

33
<meta charset="UTF-8">
4-
<meta http-equiv="refresh" content="1; url=http://diffpy.github.io/diffpy.utils/">
4+
<meta http-equiv="refresh" content="0; url=https://diffpy.github.io/diffpy.utils/">
55

66
<script>
7-
window.location.href = "http://diffpy.github.io/diffpy.utils/"
7+
window.location.href = "https://diffpy.github.io/diffpy.utils/"
88
</script>
99

1010
<title>Page Redirection</title>
1111

1212
<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
13-
If you are not redirected automatically, follow the <a href='http://diffpy.github.io/diffpy.utils/'>link</a>
13+
If you are not redirected automatically, follow the <a href='https://diffpy.github.io/diffpy.utils/'>link</a>

0 commit comments

Comments
 (0)