Skip to content
Snippets Groups Projects
Unverified Commit fb6ca470 authored by Xavier Robin's avatar Xavier Robin
Browse files

doc: cleanup and make things more consistent.

The breadcrumbs now correctly indicate the module hierarchy and can be
used to determine imports. All the documentation for ost.* is now rooted
on the base `ost` module for more clarity.
parent e9a0192f
Branches
Tags
No related merge requests found
Showing
with 54 additions and 63 deletions
...@@ -2,7 +2,22 @@ ...@@ -2,7 +2,22 @@
================================================================================ ================================================================================
.. toctree:: .. toctree::
:maxdepth: 1
generic
logging logging
../bindings/bindings
../conop/conop
../db/db
../geom/geom
../gfx/gfx
../gui/gui
../img/base/img
../io/io
../mol/base/mol
../seq/base/seq
settings settings
table
testutils testutils
:mod:`ost.settings` - Locate Files and Retrieve Preferences :mod:`~ost.settings` - Locate Files and Retrieve Preferences
================================================================================ ================================================================================
.. automodule:: ost.settings .. automodule:: ost.settings
......
File moved
:mod:`conop.cleanup <ost.conop.cleanup>` -- Sanitize structures :mod:`~ost.conop.cleanup>` -- Sanitize structures
================================================================================ ================================================================================
.. module:: ost.conop.cleanup .. module:: ost.conop.cleanup
......
Linear Database :mod:`~ost.db` - Linear Database
=============================================================================== ===============================================================================
.. currentmodule:: ost.db .. currentmodule:: ost.db
......
:mod:`img.alg <ost.img.alg>` - Image Processing Algorithms :mod:`~ost.img.alg` - Image Processing Algorithms
================================================================================ ================================================================================
.. module:: ost.img.alg .. module:: ost.img.alg
......
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
:hidden: :hidden:
point-size-extent point-size-extent
../alg/alg
.. module:: ost.img .. module:: ost.img
:synopsis: Images and density maps :synopsis: Images and density maps
......
...@@ -8,40 +8,10 @@ OpenStructure documentation ...@@ -8,40 +8,10 @@ OpenStructure documentation
install install
intro intro
users users
base/generic
base/base base/base
geom/geom
mol/base/mol
mol/alg/molalg
mol/alg/chain_mapping
mol/alg/contact_score
mol/alg/dockq
mol/alg/helix_kinks
mol/alg/ligand_scoring
mol/alg/qsscore
mol/alg/scoring
mol/alg/stereochemistry
mol/alg/structure_analysis
mol/alg/trajectory_analysis
mol/mm/molmm
conop/conop
img/base/img
img/alg/alg
seq/base/seq
seq/alg/seqalg
seq/alg/renumber
seq/alg/aaindex
db/db
bindings/bindings
io/io
gfx/gfx
gui/gui
newmodule newmodule
external external
contributing contributing
table
mol/alg/lddt
mol/alg/molck
actions actions
For Starters For Starters
...@@ -108,7 +78,7 @@ Graphical User Interface ...@@ -108,7 +78,7 @@ Graphical User Interface
Varia Varia
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
**Datasets**: :doc:`tabular data <table>` **Datasets**: :doc:`tabular data <base/table>`
**Supported File Formats**: :doc:`structure formats<io/structure_formats>` | :doc:`sequence formats <io/sequence_formats>` | :doc:`sequence profile formats <io/sequence_profile_formats>` | :doc:`image formats <io/image_formats>` **Supported File Formats**: :doc:`structure formats<io/structure_formats>` | :doc:`sequence formats <io/sequence_formats>` | :doc:`sequence profile formats <io/sequence_profile_formats>` | :doc:`image formats <io/image_formats>`
......
:mod:`mol.alg.chain_mapping <ost.mol.alg.chain_mapping>` -- Chain Mapping :mod:`~ost.mol.alg.chain_mapping` -- Chain Mapping
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
.. automodule:: ost.mol.alg.chain_mapping .. automodule:: ost.mol.alg.chain_mapping
......
:mod:`mol.alg.contact_score <ost.mol.alg.contact_score>` -- Contact based scores :mod:`~ost.mol.alg.contact_score` -- Contact-Based Scores
------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------
.. automodule:: ost.mol.alg.contact_score .. automodule:: ost.mol.alg.contact_score
:members: :members:
:member-order: bysource :member-order: bysource
:synopsis: Contact based scores :synopsis: Contact-based scores
:mod:`mol.alg.dockq <ost.mol.alg.dockq>` -- DockQ implementation :mod:`~ost.mol.alg.dockq` -- DockQ Implementation
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
.. module:: ost.mol.alg.dockq .. module:: ost.mol.alg.dockq
......
:mod:`mol.alg.helix_kinks <ost.mol.alg.helix_kinks>` -- Algorithms to calculate Helix Kinks :mod:`~ost.mol.alg.helix_kinks` -- Algorithms to Calculate Helix Kinks
--------------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------------
.. automodule:: ost.mol.alg.helix_kinks .. automodule:: ost.mol.alg.helix_kinks
......
==== :orphan:
lDDT
==== ========================
lDDT binary (deprecated)
========================
.. warning:: .. warning::
......
:mod:`mol.alg.ligand_scoring <ost.mol.alg.ligand_scoring>` -- Ligand scoring functions :mod:`~ost.mol.alg.ligand_scoring` -- Ligand scoring functions
------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------
.. module:: ost.mol.alg.ligand_scoring .. module:: ost.mol.alg.ligand_scoring
......
:mod:`mol.alg <ost.mol.alg>` -- Algorithms for Structures :mod:`~ost.mol.alg` -- Algorithms for Structures
================================================================================ ================================================================================
.. module:: ost.mol.alg .. module:: ost.mol.alg
...@@ -7,16 +7,19 @@ ...@@ -7,16 +7,19 @@
Submodules Submodules
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
* :doc:`chain_mapping – Chain Mapping <chain_mapping>` .. toctree::
* :doc:`contact_score – Contact based scores<contact_score>` :maxdepth: 1
* :doc:`dockq – DockQ implementation<dockq>`
* :doc:`helix_kinks – Algorithms to calculate Helix Kinks<helix_kinks>` chain_mapping
* :doc:`ligand_scoring – Ligand scoring functions<ligand_scoring>` contact_score
* :doc:`qsscore – New QS score implementation<qsscore>` dockq
* :doc:`scoring – Specialized scoring functions<scoring>` helix_kinks
* :doc:`stereochemistry – Stereochemistry Checks<stereochemistry>` ligand_scoring
* :doc:`structure_analysis – Functions to analyze structures<structure_analysis>` qsscore
* :doc:`trajectory_analysis – DRMSD, pairwise distances and more<trajectory_analysis>` scoring
stereochemistry
structure_analysis
trajectory_analysis
Local Distance Test scores (lDDT, DRMSD) Local Distance Test scores (lDDT, DRMSD)
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
...@@ -1451,4 +1454,3 @@ from a :class:`ost.io.MMCifInfoBioUnit` or the derived ...@@ -1451,4 +1454,3 @@ from a :class:`ost.io.MMCifInfoBioUnit` or the derived
:param bu_info: Info object :param bu_info: Info object
:type bu_info: :class:`MMCifInfoBioUnit`/:class:`BUInfo` :type bu_info: :class:`MMCifInfoBioUnit`/:class:`BUInfo`
:returns: A :class:`ost.mol.EntityHandle` of the requested biounit :returns: A :class:`ost.mol.EntityHandle` of the requested biounit
:orphan:
.. Note on large code blocks: keep max. width to 100 or it will look bad .. Note on large code blocks: keep max. width to 100 or it will look bad
on webpage! on webpage!
========================= Molck - the Molecular Checker binary (deprecated)
Molecular Checker (Molck) =================================================
=========================
-------------------------------------- --------------------------------------
Where can I find the Molck executable? Where can I find the Molck executable?
......
:mod:`mol.alg.qsscore <ost.mol.alg.qsscore>` -- New QS score implementation :mod:`~ost.mol.alg.qsscore` -- New QS Score Implementation
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
.. note:: .. note::
......
:mod:`mol.alg.scoring <ost.mol.alg.scoring>` -- Specialized scoring functions :mod:`~ost.mol.alg.scoring` -- Specialized Scoring Functions
--------------------------------------------------------------------------------- ---------------------------------------------------------------------------------
.. module:: ost.mol.alg.scoring .. module:: ost.mol.alg.scoring
......
:mod:`mol.alg.stereochemistry <ost.mol.alg.stereochemistry>` -- Stereochemistry Checks :mod:`~ost.mol.alg.stereochemistry` -- Stereochemistry Checks
-------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------
.. warning:: .. warning::
......
:mod:`mol.alg.structure_analysis <ost.mol.alg.structure_analysis>` -- Functions to analyze structures :mod:`~ost.mol.alg.structure_analysis` -- Functions to Analyze Structures
--------------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------------
.. automodule:: ost.mol.alg.structure_analysis .. automodule:: ost.mol.alg.structure_analysis
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment