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

doc: module delcaration must come first

parent 9fbdd0d4
No related branches found
No related tags found
No related merge requests found
:mod:`~ost.db` - Linear Database :mod:`~ost.db` - Linear Database
=============================================================================== ===============================================================================
.. currentmodule:: ost.db .. module:: ost.db
:synopsis: Linear database.
Many applications require to load lots of structures. Expecially on distributed Many applications require to load lots of structures. Expecially on distributed
file systems, io becomes a problem. file systems, io becomes a problem.
......
:mod:`~ost.gfx` - Realtime 3D Rendering :mod:`~ost.gfx` - Realtime 3D Rendering
================================================================================ ================================================================================
For a introduction to the :mod:`~ost.gfx` module, please have a look at the :doc:`../intro-03`.
.. module:: ost.gfx .. module:: ost.gfx
:synopsis: Realtime 3D Rendering :synopsis: Realtime 3D Rendering
For a introduction to the :mod:`~ost.gfx` module, please have a look at the :doc:`../intro-03`.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
:mod:`~ost.img` - Images and Density Maps :mod:`~ost.img` - Images and Density Maps
================================================================================ ================================================================================
.. module:: ost.img
:synopsis: Images and density maps
.. toctree:: .. toctree::
:hidden: :hidden:
point-size-extent point-size-extent
../alg/alg ../alg/alg
.. module:: ost.img
:synopsis: Images and density maps
Introduction : The ImageHandle Introduction : The ImageHandle
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
......
:mod:`~ost.io` - Input and Output of Sequences, Structures and Maps :mod:`~ost.io` - Input and Output of Sequences, Structures and Maps
================================================================================ ================================================================================
.. module:: ost.io
:synopsis: Input and output of sequences, alignments, structures, images and density maps.
.. toctree:: .. toctree::
:hidden: :hidden:
...@@ -11,10 +14,7 @@ ...@@ -11,10 +14,7 @@
mmcif mmcif
profile profile
.. module:: ost.io The io module deals with the input and output of :class:`entities
:synopsis: Input and output of sequences, alignments, structures, images and density maps.
The io module deals with the input and output of :class:`entities
<ost.mol.EntityHandle>`, :class:`alignments <ost.seq.AlignmentHandle>`, <ost.mol.EntityHandle>`, :class:`alignments <ost.seq.AlignmentHandle>`,
:class:`sequences <ost.seq.SequenceHandle>`, :class:`images :class:`sequences <ost.seq.SequenceHandle>`, :class:`images
<ost.img.ImageHandle>`. Importers for common file formats containing molecules <ost.img.ImageHandle>`. Importers for common file formats containing molecules
......
:mod:`~ost.mol.alg.qsscore` -- New QS Score Implementation :mod:`~ost.mol.alg.qsscore` -- New QS Score Implementation
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
.. module:: ost.mol.alg.qsscore
:synopsis: New QS score implementation
.. note:: .. note::
This is a new implementation of QS Score, introduced in OpenStructure 2.4 and This is a new implementation of QS Score, introduced in OpenStructure 2.4 and
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment