From 7f84095dc637f396c578ba062eed34408e0ecb04 Mon Sep 17 00:00:00 2001 From: Xavier Robin <xavier.robin@unibas.ch> Date: Mon, 1 Jul 2024 08:15:06 +0200 Subject: [PATCH] doc: module delcaration must come first --- modules/db/doc/db.rst | 4 ++-- modules/gfx/doc/gfx.rst | 4 ++-- modules/img/base/doc/img.rst | 6 +++--- modules/io/doc/io.rst | 8 ++++---- modules/mol/alg/doc/qsscore.rst | 3 +++ 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/modules/db/doc/db.rst b/modules/db/doc/db.rst index 98a15ddc0..3203a416b 100644 --- a/modules/db/doc/db.rst +++ b/modules/db/doc/db.rst @@ -1,8 +1,8 @@ :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 file systems, io becomes a problem. diff --git a/modules/gfx/doc/gfx.rst b/modules/gfx/doc/gfx.rst index de9cf3ddb..4d54795d0 100644 --- a/modules/gfx/doc/gfx.rst +++ b/modules/gfx/doc/gfx.rst @@ -1,10 +1,10 @@ :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 :synopsis: Realtime 3D Rendering + +For a introduction to the :mod:`~ost.gfx` module, please have a look at the :doc:`../intro-03`. .. toctree:: :maxdepth: 2 diff --git a/modules/img/base/doc/img.rst b/modules/img/base/doc/img.rst index 0cd470a66..b36b0cd69 100644 --- a/modules/img/base/doc/img.rst +++ b/modules/img/base/doc/img.rst @@ -1,15 +1,15 @@ :mod:`~ost.img` - Images and Density Maps ================================================================================ +.. module:: ost.img + :synopsis: Images and density maps + .. toctree:: :hidden: point-size-extent ../alg/alg -.. module:: ost.img - :synopsis: Images and density maps - Introduction : The ImageHandle -------------------------------------------------------------------------------- diff --git a/modules/io/doc/io.rst b/modules/io/doc/io.rst index 70174b375..87bd4d3c8 100644 --- a/modules/io/doc/io.rst +++ b/modules/io/doc/io.rst @@ -1,6 +1,9 @@ :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:: :hidden: @@ -11,10 +14,7 @@ mmcif profile -.. module:: ost.io - :synopsis: Input and output of sequences, alignments, structures, images and density maps. - -The io module deals with the input and output of :class:`entities +The io module deals with the input and output of :class:`entities <ost.mol.EntityHandle>`, :class:`alignments <ost.seq.AlignmentHandle>`, :class:`sequences <ost.seq.SequenceHandle>`, :class:`images <ost.img.ImageHandle>`. Importers for common file formats containing molecules diff --git a/modules/mol/alg/doc/qsscore.rst b/modules/mol/alg/doc/qsscore.rst index 1422d625a..7b6f1711f 100644 --- a/modules/mol/alg/doc/qsscore.rst +++ b/modules/mol/alg/doc/qsscore.rst @@ -1,6 +1,9 @@ :mod:`~ost.mol.alg.qsscore` -- New QS Score Implementation -------------------------------------------------------------------------------- +.. module:: ost.mol.alg.qsscore + :synopsis: New QS score implementation + .. note:: This is a new implementation of QS Score, introduced in OpenStructure 2.4 and -- GitLab