Skip to content

Commit 6ddb706

Browse files
pavoljuhaspavoljuhas
committed
Merge branch 'doc-add-changelog'
* add release notes to the manual * merge API docs in one page `package.rst` * switch to sphinx_py3doc_enhanced_theme * activate m2r for sphinx/markdown integration * add separate pages for Atom, Lattice and SpaceGroup docs
2 parents 1d59c83 + 9e15459 commit 6ddb706

File tree

8 files changed

+172
-171
lines changed

8 files changed

+172
-171
lines changed

‎doc/manual/source/conf.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
'sphinx.ext.intersphinx',
4242
# 'sphinx.ext.coverage',
4343
# 'sphinx.ext.doctest',
44+
'm2r',
4445
]
4546

4647
# Add any paths that contain templates here, relative to this directory.
@@ -50,7 +51,7 @@
5051
# You can specify multiple suffix as a list of string:
5152
#
5253
# source_suffix = ['.rst', '.md']
53-
source_suffix = '.rst'
54+
source_suffix = ['.rst', '.md']
5455

5556
# The master toctree document.
5657
master_doc = 'index'
@@ -124,13 +125,16 @@
124125
# The theme to use for HTML and HTML Help pages. See the documentation for
125126
# a list of builtin themes.
126127
#
127-
html_theme = 'classic'
128+
html_theme = 'sphinx_py3doc_enhanced_theme'
128129

129130
# Theme options are theme-specific and customize the look and feel of a theme
130131
# further. For a list of options available for each theme, see the
131132
# documentation.
132133
#
133-
html_theme_options = {'collapsiblesidebar' : 'true'}
134+
html_theme_options = {
135+
'collapsiblesidebar' : 'true',
136+
'navigation_with_keys' : 'true',
137+
}
134138

135139
# Add any paths that contain custom static files (such as style sheets) here,
136140
# relative to this directory. They are copied after the builtin static files,
@@ -197,7 +201,7 @@
197201
# -- intersphinx configuration --------------------------------------------
198202

199203
intersphinx_mapping = {
200-
'python' : ('https://docs.python.org/3.6', None),
204+
'python' : ('https://docs.python.org/3.7', None),
201205
'numpy' : ('https://docs.scipy.org/doc/numpy', None),
202206
}
203207

‎doc/manual/source/index.rst

Lines changed: 15 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
diffpy.structure documentation
33
########################################################################
44

5-
Software version |release|.
6-
7-
Last updated |today|.
8-
95
diffpy.structure - simple storage and manipulation of crystal structures
106

7+
| Software version |release|.
8+
| Last updated |today|.
9+
1110
The diffpy.structure package provides objects for storing atomic
1211
coordinates, displacement parameters and other crystal structure data.
1312
diffpy.structure supports import and export of structure data in several
@@ -18,65 +17,6 @@ constraints for atom positions and displacement parameters. diffpy.structure
1817
includes definitions of all space groups in over 500 symmetry settings.
1918

2019

21-
Package contents
22-
========================================================================
23-
24-
.. module:: diffpy.structure
25-
26-
The top-level diffpy.structure module provides the following objects.
27-
28-
29-
Functions
30-
---------
31-
32-
.. autofunction:: loadStructure
33-
34-
35-
Classes
36-
-------
37-
38-
:py:class:`~atom.Atom`
39-
describes one atom site in the structure - its type, position,
40-
displacement parameters and so forth.
41-
42-
:py:class:`~lattice.Lattice`
43-
depicts general coordinate system and associated operations.
44-
45-
:py:class:`~structure.Structure`
46-
collection of :class:`!Atom` objects that form the structure together
47-
with associated :py:class:`!Lattice`.
48-
49-
50-
Exceptions
51-
----------
52-
53-
.. autoclass:: StructureFormatError
54-
55-
.. autoclass:: LatticeError
56-
57-
.. autoclass:: SymmetryError
58-
59-
60-
Submodules
61-
========================================================================
62-
63-
.. toctree::
64-
:maxdepth: 2
65-
66-
mod_lattice.rst
67-
68-
69-
**FIXME BELOW**
70-
71-
:doc:`submodules`
72-
73-
* :ref:`genindex`
74-
75-
**FIXME TO HERE**
76-
77-
----
78-
79-
8020
Authors
8121
========================================================================
8222

@@ -115,10 +55,19 @@ by citing the following paper in your publication:
11555
*Acta Crystallogr. A* **71**, 562-568 (2015).
11656

11757

58+
Table of contents
59+
========================================================================
11860

119-
.. index:: license
61+
.. toctree::
62+
:titlesonly:
63+
64+
license
65+
release
66+
package
12067

121-
License
68+
69+
Indices
12270
========================================================================
12371

124-
.. literalinclude:: ../../../LICENSE.txt
72+
* :ref:`genindex`
73+
* :ref:`search`

‎doc/manual/source/license.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. index:: license
2+
13
License
24
#######
35

‎doc/manual/source/mod_atom.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
diffpy.structure.atom
2+
=====================
3+
4+
.. automodule:: diffpy.structure.atom
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎doc/manual/source/mod_spacegroup.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
diffpy.structure.spacegroupmod
2+
==============================
3+
4+
.. automodule:: diffpy.structure.spacegroupmod
5+
:members:
6+
:undoc-members:
7+
:special-members: __call__, __eq__

‎doc/manual/source/package.rst

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
:tocdepth: 2
2+
3+
Package API
4+
###########
5+
6+
7+
Submodules
8+
==========
9+
10+
.. toctree::
11+
:titlesonly:
12+
13+
mod_atom
14+
mod_lattice
15+
mod_spacegroup
16+
diffpy.structure.parsers
17+
diffpy.structure.applications
18+
diffpy.structure.expansion
19+
20+
21+
diffpy.structure
22+
================
23+
24+
.. module:: diffpy.structure
25+
26+
The top-level diffpy.structure module provides the following objects.
27+
28+
29+
Functions
30+
---------
31+
32+
.. autofunction:: loadStructure
33+
34+
35+
Classes
36+
-------
37+
38+
:py:class:`~atom.Atom`
39+
describes one atom site in the structure - its type, position,
40+
displacement parameters and so forth.
41+
42+
:py:class:`~lattice.Lattice`
43+
depicts general coordinate system and associated operations.
44+
45+
:py:class:`~structure.Structure`
46+
collection of :class:`!Atom` objects that form the structure together
47+
with associated :py:class:`!Lattice`.
48+
49+
50+
Exceptions
51+
----------
52+
53+
.. autoclass:: StructureFormatError
54+
55+
.. autoclass:: LatticeError
56+
57+
.. autoclass:: SymmetryError
58+
59+
60+
diffpy.structure.spacegroups
61+
============================
62+
63+
.. automodule:: diffpy.structure.spacegroups
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
diffpy.structure.structureerrors
69+
================================
70+
71+
.. automodule:: diffpy.structure.structureerrors
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
diffpy.structure.symmetryutilities
77+
==================================
78+
79+
.. automodule:: diffpy.structure.symmetryutilities
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
diffpy.structure.mmlibspacegroups
85+
=================================
86+
87+
.. automodule:: diffpy.structure.mmlibspacegroups
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
diffpy.structure.pdffitstructure
93+
================================
94+
95+
.. automodule:: diffpy.structure.pdffitstructure
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
diffpy.structure.sgtbxspacegroups
101+
=================================
102+
103+
.. automodule:: diffpy.structure.sgtbxspacegroups
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:
107+
108+
diffpy.structure.structure
109+
==========================
110+
111+
.. automodule:: diffpy.structure.structure
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:
115+
116+
diffpy.structure.utils
117+
======================
118+
119+
.. automodule:: diffpy.structure.utils
120+
:members:
121+
:undoc-members:
122+
:show-inheritance:
123+
124+
diffpy.structure.version
125+
========================
126+
127+
.. automodule:: diffpy.structure.version
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:

‎doc/manual/source/release.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. index:: release notes
2+
3+
.. mdinclude:: ../../../CHANGELOG.md

0 commit comments

Comments
 (0)