From 4beb2cf9010fbf9448ea215e66d217139e402809 Mon Sep 17 00:00:00 2001
From: Xavier Robin <xavalias-github@xavier.robin.name>
Date: Tue, 5 Dec 2023 13:39:45 +0100
Subject: [PATCH] doc: add LoadSDF (old) and SaveSDF (new)
---
modules/io/doc/io.rst | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/modules/io/doc/io.rst b/modules/io/doc/io.rst
index 9e6a01f43..fad95f3c7 100644
--- a/modules/io/doc/io.rst
+++ b/modules/io/doc/io.rst
@@ -95,6 +95,16 @@ behaviour.
pdb_str = pdb.read()
ent = io.PDBStrToEntity(pdb_str, ost.io.profiles['DEFAULT'], True)
+
+.. function:: LoadSDF(filename)
+
+ Load an SDF file and return an entity.
+
+ :param filename: File to be loaded
+ :type filename: :class:`str`
+
+ :rtype: :class:`~ost.mol.EntityHandle`
+
.. function:: SDFStrToEntity(sdf_string)
Load entity from a string in SDF format.
@@ -316,6 +326,15 @@ file:
:rtype: string.
+.. function:: SaveSDF(ent, filename)
+
+ Save entity to disk as an SDF file.
+
+ :param ent: The entity to be saved
+ :type ent: :class:`~ost.mol.EntityHandle` or :class:`~ost.mol.EntityView`
+ :param filename: The filename
+ :type filename: string
+
.. _seq-io:
Sequences and Alignments
--
GitLab