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
061412e7
Verified
Commit
061412e7
authored
1 year ago
by
Xavier Robin
Browse files
Options
Downloads
Patches
Plain Diff
doc: fix sphinx warnings about duplicate object description
parent
4a1815f1
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
modules/io/doc/io.rst
+3
-13
3 additions, 13 deletions
modules/io/doc/io.rst
modules/mol/base/doc/editors.rst
+6
-17
6 additions, 17 deletions
modules/mol/base/doc/editors.rst
modules/mol/base/doc/entity.rst
+1
-1
1 addition, 1 deletion
modules/mol/base/doc/entity.rst
with
10 additions
and
31 deletions
modules/io/doc/io.rst
+
3
−
13
View file @
061412e7
...
...
@@ -549,13 +549,7 @@ Loading Density Maps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. function:: LoadImage(filename)
Load density map from disk with the extension being guessed by the function.
:param filename: The filename
:type filename: string
.. function:: LoadImage(filename, format)
LoadImage(filename, format)
Load density map from disk. If no format is given, the function guesses the
filetype based on the extension of the file. If the extension is unknown or not present the
...
...
@@ -589,12 +583,8 @@ Loading Density Maps
Saving Density Maps
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. function:: SaveImage(image,filename)
Save density map to disk with the function guessing the
filetype based on the file extension.
.. function:: SaveImage(image,filename, format)
.. function:: SaveImage(image, filename)
SaveImage(image, filename, format)
Save density map to disk. If no format is set, the function guesses the
filetype based on the file extension.
...
...
This diff is collapsed.
Click to expand it.
modules/mol/base/doc/editors.rst
+
6
−
17
View file @
061412e7
...
...
@@ -192,6 +192,7 @@ The basic functionality of editors is implemented in the EditorBase class.
:returns: :class:`AtomHandle`
.. method:: InsertAltAtom(residue, atom, alt_group)
:noindex:
Insert new atom with alternative position indicator
...
...
@@ -336,6 +337,7 @@ The basic functionality of editors is implemented in the EditorBase class.
:type new_numbers: :class:`ResNumList`
.. method:: RenumberChain(chain, start, keep_spacing)
:noindex:
Renumber residues of the given chain
...
...
@@ -409,29 +411,14 @@ Euclidian space.
atoms positions.
:param transform: The transformation to be applied
:type transform: :class:`geom.Mat4`
.. method:: ApplyTransform(transform)
Apply a transformation to the entity. The transformation is applied to all
atoms positions.
:param transform: The transformation to be applied
:type transform: :class:`Transform`
:type transform: :class:`geom.Mat4` or :class:`Transform`
.. method:: SetTransform(transform)
Set the entity transformation. See also :meth:`ApplyTransform`
:param transform: The transformation to be applied
:type transform: :class:`geom.Mat4`
.. method:: SetTransform(transform)
Set the entity transformation. See also :meth:`ApplyTransform`
:param transform: The transformation to be applied
:type transform: :class:`Transform`
:type transform: :class:`geom.Mat4` or :class:`Transform`
.. method:: FixTransform()
...
...
@@ -544,6 +531,7 @@ using an :class:`ICSEditor` is undefined and vice versa.
.. method:: SetTorsionAngle(atom1, atom2, atom3, atom4, angle, update_others=True)
:noindex:
Set the angles of the given atoms. All connectors at the third atom (A3) will be adjusted accordingly.
If you only want to adjust the bond between A3 and A4, and leave
...
...
@@ -587,6 +575,7 @@ using an :class:`ICSEditor` is undefined and vice versa.
.. method:: RotateTorsionAngle(atom1, atom2, atom3, atom4, angle, update_others=True)
:noindex:
Rotate torsion angle
...
...
This diff is collapsed.
Click to expand it.
modules/mol/base/doc/entity.rst
+
1
−
1
View file @
061412e7
...
...
@@ -2343,7 +2343,7 @@ Other Entity-Related Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. function:: CreateViewFromAtoms(atom_list)
.. function::
CreateViewFromAtomList(atom_list)
CreateViewFromAtomList(atom_list)
Returns a view made up of the atoms in *atom_list*. All atoms are required to
be atoms of the same entity. Duplicate atoms are only added to the view once.
...
...
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