Skip to content

Commit 08bd9f5

Browse files
prjemianprjemian
committed
DOC #14 w-i-p
1 parent ac597b0 commit 08bd9f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+208
-300
lines changed

‎docs/source/api.rst

+10-7
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@
44
API
55
===
66

7-
.. include:: /substitutions.txt
8-
97
Application-Programmer Interface - the source code.
108

119
.. figure:: _static/hklpy2-block-diagram.png
1210
:alt: Block hklpy2-block-diagram
1311

1412
Functional blocks in |hklpy2|.
1513

16-
.. toctree::
17-
:glob:
18-
:maxdepth: 3
14+
.. autosummary::
15+
:toctree: generated
1916

20-
api/*
21-
license
17+
~hklpy2.backends
18+
~hklpy2.blocks
19+
~hklpy2.diffract
20+
~hklpy2.geom
21+
~hklpy2.misc
22+
~hklpy2.ops
23+
~hklpy2.user
24+
~hklpy2.wavelength_support

‎docs/source/api/backends/base.rst

-21
This file was deleted.

‎docs/source/api/backends/hkl_soleil.rst

-20
This file was deleted.

‎docs/source/api/backends/no_op.rst

-16
This file was deleted.

‎docs/source/api/backends/th_tth_q.rst

-16
This file was deleted.

‎docs/source/api/configure.rst

-21
This file was deleted.

‎docs/source/api/geom.rst

-15
This file was deleted.

‎docs/source/api/sample.rst

-16
This file was deleted.

‎docs/source/api/wavelength_support.rst

-16
This file was deleted.

‎docs/source/api/z_misc.rst

-16
This file was deleted.

‎docs/source/concepts.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _concepts:
2+
3+
==========
4+
Concepts
5+
==========
6+
7+
.. toctree::
8+
:glob:
9+
:hidden:
10+
11+
concepts/*

‎docs/source/api/constraints.rst ‎docs/source/concepts/constraints.rst

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. include:: /substitutions.txt
2-
31
.. index::
42
!constraint
53
mode
@@ -17,11 +15,11 @@ coordinates can have many solutions. One or more constraints (Constraint)
1715
* Limit the range of ``forward()`` solutions accepted for that positioner.
1816
* Declare the value to use when the positioner should be kept constant. (not implemented yet)
1917

20-
Source Code Documentation
21-
-------------------------
18+
.. Source Code Documentation
19+
.. -------------------------
2220
23-
.. automodule :: hklpy2.blocks.constraints
24-
:members:
25-
:private-members:
26-
:show-inheritance:
27-
:inherited-members:
21+
.. .. automodule :: hklpy2.blocks.constraints
22+
.. :members:
23+
.. :private-members:
24+
.. :show-inheritance:
25+
.. :inherited-members:

‎docs/source/api/diffract.rst ‎docs/source/concepts/diffract.rst

+12-14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. include:: /substitutions.txt
2-
31
.. _api.diffract:
42

53
==================
@@ -93,19 +91,19 @@ and :attr:`~hklpy2.ops.Operations.sample`)
9391
~hklpy2.blocks.sample.Sample.U (property)
9492
~hklpy2.blocks.sample.Sample.UB (property)
9593

96-
Source Code Documentation
97-
-------------------------
94+
.. Source Code Documentation
95+
.. -------------------------
9896
99-
.. automodule:: hklpy2.diffract
100-
:members:
101-
:private-members:
102-
:show-inheritance:
97+
.. .. automodule:: hklpy2.diffract
98+
.. :members:
99+
.. :private-members:
100+
.. :show-inheritance:
103101
104-
Inherited members, from ``ophyd.PseudoPositioner``
105-
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
102+
.. Inherited members, from ``ophyd.PseudoPositioner``
103+
.. +++++++++++++++++++++++++++++++++++++++++++++++++++++++
106104
107-
.. so many inherited members, list separately
105+
.. .. so many inherited members, list separately
108106
109-
.. automodule:: hklpy2.diffract
110-
:inherited-members:
111-
:no-index:
107+
.. .. automodule:: hklpy2.diffract
108+
.. :inherited-members:
109+
.. :no-index:

‎docs/source/concepts/geom.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _api.geometry:
2+
3+
====================================
4+
Diffractometer Geometries
5+
====================================
6+
7+
.. Source Code Documentation
8+
.. -------------------------
9+
10+
.. .. automodule:: hklpy2.geom
11+
.. :members:
12+
.. :private-members:
13+
.. :show-inheritance:

‎docs/source/api/lattice.rst ‎docs/source/concepts/lattice.rst

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. include:: /substitutions.txt
2-
31
.. _api.lattice:
42

53
==================
@@ -54,11 +52,11 @@ triclinic ``Lattice(4, 5, 3, 75., 85., 95.)`` 4 5 3 75 85 95
5452
>>> Lattice(4, 5, 3, 75., 85., 95.)
5553
Lattice(a=4, b=5, c=3, alpha=75.0, beta=85.0, gamma=95.0)
5654

57-
Source Code Documentation
58-
-------------------------
55+
.. Source Code Documentation
56+
.. -------------------------
5957
60-
.. automodule:: hklpy2.blocks.lattice
61-
:members:
62-
:private-members:
63-
:show-inheritance:
64-
:inherited-members:
58+
.. .. automodule:: hklpy2.blocks.lattice
59+
.. :members:
60+
.. :private-members:
61+
.. :show-inheritance:
62+
.. :inherited-members:

‎docs/source/api/ops.rst ‎docs/source/concepts/ops.rst

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. include:: /substitutions.txt
2-
31
.. _api.ops:
42

53
==================
@@ -72,11 +70,11 @@ EXAMPLE::
7270
'E4CV'
7371

7472

75-
Source Code Documentation
76-
-------------------------
73+
.. Source Code Documentation
74+
.. -------------------------
7775
78-
.. automodule:: hklpy2.ops
79-
:members:
80-
:private-members:
81-
:show-inheritance:
82-
:inherited-members:
76+
.. .. automodule:: hklpy2.ops
77+
.. :members:
78+
.. :private-members:
79+
.. :show-inheritance:
80+
.. :inherited-members:

‎docs/source/api/reflection.rst ‎docs/source/concepts/reflection.rst

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. include:: /substitutions.txt
2-
31
.. _api.reflection:
42

53
======================
@@ -27,11 +25,11 @@ Note that the engineering units for the pseudo axes are the reciprocal of the
2725
units of the wavelength (where *angstroms* is typical). The angles are reported
2826
in *degrees*.
2927

30-
Source Code Documentation
31-
-------------------------
28+
.. Source Code Documentation
29+
.. -------------------------
3230
33-
.. automodule:: hklpy2.blocks.reflection
34-
:members:
35-
:private-members:
36-
:show-inheritance:
37-
:inherited-members:
31+
.. .. automodule:: hklpy2.blocks.reflection
32+
.. :members:
33+
.. :private-members:
34+
.. :show-inheritance:
35+
.. :inherited-members:

‎docs/source/concepts/sample.rst

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _api.sample:
2+
3+
==================
4+
Crystalline Sample
5+
==================
6+
7+
.. Source Code Documentation
8+
.. -------------------------
9+
10+
.. .. automodule:: hklpy2.blocks.sample
11+
.. :members:
12+
.. :private-members:
13+
.. :show-inheritance:
14+
.. :inherited-members:

0 commit comments

Comments
 (0)