Update documentation

LBC-LNBio · Oct 23, 2024 · 3027380 · 3027380 · github-actions · Oct 23, 2024
1 parent efb1532
commit 3027380
Show file tree

Hide file tree

Showing 6 changed files with 4 additions and 4 deletions.
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -4,7 +4,7 @@ Welcome to pyKVFinder's documentation!
 
 Welcome to the **Python-C parallel KVFinder (pyKVFinder)** documentation, this page was built to help you get started with our cavity detection and characterization package.
 
-pyKVFinder is an open-source Python package designed for detecting and characterizing cavities in biomolecular structures. It employs a geometric grid-and-sphere-based method with a dual-probe system to detect cavities, and provides a comprehensive information regarding their spatial, depth, constitutional, and hydropathy characteristics. In addition to cavity detection, pyKVFinder also estimates the molecular volume, using van der Waals (vdW) surface, solvent excluded surface (SES), and solvent accessible surface (SAS) to represent the molecular surface. 
+pyKVFinder is an open-source Python package designed for detecting and characterizing cavities in biomolecular structures. It employs a geometric grid-and-sphere-based method with a dual-probe system to detect cavities and provides a detailed information about their spatial, depth, constitutional, and hydropathy characteristics. In addition to cavity detection, pyKVFinder also estimates the molecular volume, using van der Waals (vdW) surface, solvent excluded surface (SES), and solvent accessible surface (SAS) to represent the molecular surface. 
 
 .. Headings:
 ..  # with overline, for parts

diff --git a/docs/index.html b/docs/index.html
@@ -97,7 +97,7 @@
   <section id="welcome-to-pykvfinder-s-documentation">
 <h1>Welcome to pyKVFinder’s documentation!<a class="headerlink" href="#welcome-to-pykvfinder-s-documentation" title="Link to this heading"></a></h1>
 <p>Welcome to the <strong>Python-C parallel KVFinder (pyKVFinder)</strong> documentation, this page was built to help you get started with our cavity detection and characterization package.</p>
-<p>pyKVFinder is an open-source Python package designed for detecting and characterizing cavities in biomolecular structures. It employs a geometric grid-and-sphere-based method with a dual-probe system to detect cavities, and provides a comprehensive information regarding their spatial, depth, constitutional, and hydropathy characteristics. In addition to cavity detection, pyKVFinder also estimates the molecular volume, using van der Waals (vdW) surface, solvent excluded surface (SES), and solvent accessible surface (SAS) to represent the molecular surface.</p>
+<p>pyKVFinder is an open-source Python package designed for detecting and characterizing cavities in biomolecular structures. It employs a geometric grid-and-sphere-based method with a dual-probe system to detect cavities and provides a detailed information about their spatial, depth, constitutional, and hydropathy characteristics. In addition to cavity detection, pyKVFinder also estimates the molecular volume, using van der Waals (vdW) surface, solvent excluded surface (SES), and solvent accessible surface (SAS) to represent the molecular surface.</p>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Python Package</span></p>
 <ul>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,7 +4,7 @@ Welcome to pyKVFinder's documentation!
 
 Welcome to the **Python-C parallel KVFinder (pyKVFinder)** documentation, this page was built to help you get started with our cavity detection and characterization package.
 
-pyKVFinder is an open-source Python package designed for detecting and characterizing cavities in biomolecular structures. It employs a geometric grid-and-sphere-based method with a dual-probe system to detect cavities, and provides a comprehensive information regarding their spatial, depth, constitutional, and hydropathy characteristics. In addition to cavity detection, pyKVFinder also estimates the molecular volume, using van der Waals (vdW) surface, solvent excluded surface (SES), and solvent accessible surface (SAS) to represent the molecular surface. 
+pyKVFinder is an open-source Python package designed for detecting and characterizing cavities in biomolecular structures. It employs a geometric grid-and-sphere-based method with a dual-probe system to detect cavities and provides a detailed information about their spatial, depth, constitutional, and hydropathy characteristics. In addition to cavity detection, pyKVFinder also estimates the molecular volume, using van der Waals (vdW) surface, solvent excluded surface (SES), and solvent accessible surface (SAS) to represent the molecular surface. 
 
 .. Headings:
 ..  # with overline, for parts
File	Stmts	Miss	Cover	Missing
pyKVFinder
grid.py	729	112	85%	918, 922, 2243–2263, 2400–2477, 2749–2766, 2867–2936
main.py	361	69	81%	93, 97, 105, 114, 142–148, 495, 660, 1061, 1068, 1078, 1089, 1108, 1113–1114, 1340, 1345, 1351, 1358, 1361–1364, 1368–1373, 1385, 1395, 1424–1425, 1430–1431, 1436–1437, 1497–1502, 1508, 1513–1518, 1578, 1580, 1593, 1704, 1706, 1712, 1714, 1720, 1725, 1729, 1782–1792, 1818
utils.py	312	6	98%	571, 603, 606–608, 630
TOTAL	1402	187	87%