Skip to content
Snippets Groups Projects
Verified Commit 84b7360c authored by Xavier Robin's avatar Xavier Robin
Browse files

doc: add sub headings to facilitate navigation

parent be93bcc5
No related branches found
No related tags found
No related merge requests found
...@@ -15,7 +15,10 @@ The Handle Classes ...@@ -15,7 +15,10 @@ The Handle Classes
entity, use an :doc:`entity editor <editors>`. entity, use an :doc:`entity editor <editors>`.
:returns: The newly created :class:`EntityHandle` :returns: The newly created :class:`EntityHandle`
Entity Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: EntityHandle .. class:: EntityHandle
The entity class represents a molecular structure. Such a structure is in The entity class represents a molecular structure. Such a structure is in
...@@ -338,7 +341,10 @@ The Handle Classes ...@@ -338,7 +341,10 @@ The Handle Classes
.. method:: IsValid() .. method:: IsValid()
See :attr:`valid` See :attr:`valid`
Chain Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ChainHandle .. class:: ChainHandle
A chain of one or more :class:`residues <ResidueHandle>`. Chains are always A chain of one or more :class:`residues <ResidueHandle>`. Chains are always
...@@ -577,6 +583,9 @@ The Handle Classes ...@@ -577,6 +583,9 @@ The Handle Classes
See :attr:`valid` See :attr:`valid`
Residue Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ResidueHandle .. class:: ResidueHandle
The residue is either used to represent complete molecules or building blocks The residue is either used to represent complete molecules or building blocks
...@@ -1010,6 +1019,8 @@ The Handle Classes ...@@ -1010,6 +1019,8 @@ The Handle Classes
See :attr:`next` See :attr:`next`
Atom Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: AtomHandle .. class:: AtomHandle
...@@ -1251,6 +1262,8 @@ The Handle Classes ...@@ -1251,6 +1262,8 @@ The Handle Classes
See :attr:`valid` See :attr:`valid`
Bond Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: BondHandle .. class:: BondHandle
...@@ -1354,10 +1367,15 @@ The Handle Classes ...@@ -1354,10 +1367,15 @@ The Handle Classes
The View Classes The View Classes
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
Entity View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: EntityView .. class:: EntityView
An entity view represents a structural subset of an :class:`EntityHandle`. For An entity view represents a structural subset of an :class:`EntityHandle` and
an introduction, see :doc:`../../intro-01`. contains :class:`ChainView`\s, :class:`ResidueView`\s, :class:`AtomView`\s and
:class:`BondHandle`\s.
For an introduction, see :doc:`../../intro-01`.
.. attribute:: handle .. attribute:: handle
...@@ -1743,6 +1761,9 @@ The View Classes ...@@ -1743,6 +1761,9 @@ The View Classes
See :attr:`valid` See :attr:`valid`
Chain View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ChainView .. class:: ChainView
A view representation of a :class:`ChainHandle`. Mostly, the same A view representation of a :class:`ChainHandle`. Mostly, the same
...@@ -1988,6 +2009,9 @@ The View Classes ...@@ -1988,6 +2009,9 @@ The View Classes
:type flags: :class:`int` / :class:`QueryFlag` :type flags: :class:`int` / :class:`QueryFlag`
:rtype: :class:`EntityView` :rtype: :class:`EntityView`
Residue View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ResidueView .. class:: ResidueView
A view representation of a :class:`ResidueHandle`. Mostly, the same A view representation of a :class:`ResidueHandle`. Mostly, the same
...@@ -2171,6 +2195,8 @@ The View Classes ...@@ -2171,6 +2195,8 @@ The View Classes
:type flags: :class:`int` / :class:`QueryFlag` :type flags: :class:`int` / :class:`QueryFlag`
:rtype: :class:`EntityView` :rtype: :class:`EntityView`
Atom View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: AtomView .. class:: AtomView
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment