Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
openstructure
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Container Registry
Model registry
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
schwede
openstructure
Commits
84b7360c
Verified
Commit
84b7360c
authored
1 year ago
by
Xavier Robin
Browse files
Options
Downloads
Patches
Plain Diff
doc: add sub headings to facilitate navigation
parent
be93bcc5
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
modules/mol/base/doc/entity.rst
+30
-4
30 additions, 4 deletions
modules/mol/base/doc/entity.rst
with
30 additions
and
4 deletions
modules/mol/base/doc/entity.rst
+
30
−
4
View file @
84b7360c
...
...
@@ -15,7 +15,10 @@ The Handle Classes
entity, use an :doc:`entity editor <editors>`.
:returns: The newly created :class:`EntityHandle`
Entity Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: EntityHandle
The entity class represents a molecular structure. Such a structure is in
...
...
@@ -338,7 +341,10 @@ The Handle Classes
.. method:: IsValid()
See :attr:`valid`
Chain Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ChainHandle
A chain of one or more :class:`residues <ResidueHandle>`. Chains are always
...
...
@@ -577,6 +583,9 @@ The Handle Classes
See :attr:`valid`
Residue Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ResidueHandle
The residue is either used to represent complete molecules or building blocks
...
...
@@ -1010,6 +1019,8 @@ The Handle Classes
See :attr:`next`
Atom Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: AtomHandle
...
...
@@ -1251,6 +1262,8 @@ The Handle Classes
See :attr:`valid`
Bond Handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: BondHandle
...
...
@@ -1354,10 +1367,15 @@ The Handle Classes
The View Classes
--------------------------------------------------------------------------------
Entity View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: EntityView
An entity view represents a structural subset of an :class:`EntityHandle`. For
an introduction, see :doc:`../../intro-01`.
An entity view represents a structural subset of an :class:`EntityHandle` and
contains :class:`ChainView`\s, :class:`ResidueView`\s, :class:`AtomView`\s and
:class:`BondHandle`\s.
For an introduction, see :doc:`../../intro-01`.
.. attribute:: handle
...
...
@@ -1743,6 +1761,9 @@ The View Classes
See :attr:`valid`
Chain View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ChainView
A view representation of a :class:`ChainHandle`. Mostly, the same
...
...
@@ -1988,6 +2009,9 @@ The View Classes
:type flags: :class:`int` / :class:`QueryFlag`
:rtype: :class:`EntityView`
Residue View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: ResidueView
A view representation of a :class:`ResidueHandle`. Mostly, the same
...
...
@@ -2171,6 +2195,8 @@ The View Classes
:type flags: :class:`int` / :class:`QueryFlag`
:rtype: :class:`EntityView`
Atom View
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. class:: AtomView
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment