Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
seidelt committed Jan 26, 2024
1 parent b1a008c commit 5583600
Show file tree
Hide file tree
Showing 28 changed files with 225 additions and 68 deletions.
Binary file modified master/.doctrees/applications/confgen.doctree
Binary file not shown.
Binary file modified master/.doctrees/applications/psdscreen.doctree
Binary file not shown.
Binary file modified master/.doctrees/applications/tautgen.doctree
Binary file not shown.
Binary file modified master/.doctrees/environment.pickle
Binary file not shown.
6 changes: 3 additions & 3 deletions master/_sources/applications/confgen.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Other options
-e [ --e-window ] arg

Energy window for generated conformers. The energy window may be specified as a
single constant value or as a list of pairs RBC1 EW1 RBC2 EW2... where RBC
single constant value or (since V1.1) as a list of pairs RBC1 EW1 RBC2 EW2... where RBC
denotes a rotatable bond count and EW the energy window that applies if the
rotatable bond count of the processed molecule is <= RBC (the EW value
associated with the lowest RBC that fulfills the latter condition takes
Expand All @@ -138,7 +138,7 @@ Other options
-r [ --rmsd ] arg

Minimum RMSD for output conformer selection. The RMSD may be specified as
a single constant value or as a list of pairs RBC1 RMSD1 RBC2 RMSD2... where
a single constant value or (since V1.1) as a list of pairs RBC1 RMSD1 RBC2 RMSD2... where
RBC denotes a rotatable bond count and RMSD is the value that applies if the
rotatable bond count of the processed molecule is <= RBC (the RMSD value
associated with the lowest RBC that fulfills the latter condition takes
Expand All @@ -150,7 +150,7 @@ Other options
-n [ --max-num-out-confs ] arg

Maximum number of output conformers per molecule. The max. number of output
conformers may be specified as a single constant value or as a list of pairs
conformers may be specified as a single constant value or (since V1.1) as a list of pairs
RBC1 MC1 RBC2 MC2... where RBC denotes a rotatable bond count and MC the max.
number of conformers that applies if the rotatable bond count of the
processed molecule is <= RBC (the MC value associated with the lowest RBC
Expand Down
2 changes: 1 addition & 1 deletion master/_sources/applications/psdscreen.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Other options

-u [ --unique-hits ] [=arg(=1)]

Report molecules matching multiple query pharmacophores only once (default: false).
Report molecules matching multiple query pharmacophores only once (default: false); since V1.1

-O [ --output-format ] arg

Expand Down
2 changes: 1 addition & 1 deletion master/_sources/applications/tautgen.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Other options

-S [ --title-suffix ] [=arg(=1)]

Append tautomer number to the title of the output molecules (default: false; since V1.1).
Append tautomer number to the title of the output molecules (default: false); since V1.1

--keto-enol [=arg(=1)]

Expand Down
6 changes: 3 additions & 3 deletions master/applications/confgen.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ <h2>Other options<a class="headerlink" href="#other-options" title="Permalink to
<p>-e [ –e-window ] arg</p>
<blockquote>
<div><p>Energy window for generated conformers. The energy window may be specified as a
single constant value or as a list of pairs RBC1 EW1 RBC2 EW2… where RBC
single constant value or (since V1.1) as a list of pairs RBC1 EW1 RBC2 EW2… where RBC
denotes a rotatable bond count and EW the energy window that applies if the
rotatable bond count of the processed molecule is &lt;= RBC (the EW value
associated with the lowest RBC that fulfills the latter condition takes
Expand All @@ -253,7 +253,7 @@ <h2>Other options<a class="headerlink" href="#other-options" title="Permalink to
<p>-r [ –rmsd ] arg</p>
<blockquote>
<div><p>Minimum RMSD for output conformer selection. The RMSD may be specified as
a single constant value or as a list of pairs RBC1 RMSD1 RBC2 RMSD2… where
a single constant value or (since V1.1) as a list of pairs RBC1 RMSD1 RBC2 RMSD2… where
RBC denotes a rotatable bond count and RMSD is the value that applies if the
rotatable bond count of the processed molecule is &lt;= RBC (the RMSD value
associated with the lowest RBC that fulfills the latter condition takes
Expand All @@ -265,7 +265,7 @@ <h2>Other options<a class="headerlink" href="#other-options" title="Permalink to
<p>-n [ –max-num-out-confs ] arg</p>
<blockquote>
<div><p>Maximum number of output conformers per molecule. The max. number of output
conformers may be specified as a single constant value or as a list of pairs
conformers may be specified as a single constant value or (since V1.1) as a list of pairs
RBC1 MC1 RBC2 MC2… where RBC denotes a rotatable bond count and MC the max.
number of conformers that applies if the rotatable bond count of the
processed molecule is &lt;= RBC (the MC value associated with the lowest RBC
Expand Down
2 changes: 1 addition & 1 deletion master/applications/psdscreen.html
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ <h2>Other options<a class="headerlink" href="#other-options" title="Permalink to
</div></blockquote>
<p>-u [ –unique-hits ] [=arg(=1)]</p>
<blockquote>
<div><p>Report molecules matching multiple query pharmacophores only once (default: false).</p>
<div><p>Report molecules matching multiple query pharmacophores only once (default: false); since V1.1</p>
</div></blockquote>
<p>-O [ –output-format ] arg</p>
<blockquote>
Expand Down
2 changes: 1 addition & 1 deletion master/applications/tautgen.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ <h2>Other options<a class="headerlink" href="#other-options" title="Permalink to
</div></blockquote>
<p>-S [ –title-suffix ] [=arg(=1)]</p>
<blockquote>
<div><p>Append tautomer number to the title of the output molecules (default: false; since V1.1).</p>
<div><p>Append tautomer number to the title of the output molecules (default: false); since V1.1</p>
</div></blockquote>
<p class="attribution">—keto-enol [=arg(=1)]</p>
</div></blockquote>
Expand Down
4 changes: 2 additions & 2 deletions master/cdpl_api_doc/c++_api_doc/BuildInfo_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
<tr class="memitem:a51e57b678c884de89185798ef6128d94"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="BuildInfo_8hpp.html#a51e57b678c884de89185798ef6128d94">CDPL_BUILD_SYSTEM</a>&#160;&#160;&#160;&quot;Linux-4.18.0-394.el8.x86_64&quot;</td></tr>
<tr class="memdesc:a51e57b678c884de89185798ef6128d94"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em>CDPL</em> build system information. <a href="BuildInfo_8hpp.html#a51e57b678c884de89185798ef6128d94">More...</a><br /></td></tr>
<tr class="separator:a51e57b678c884de89185798ef6128d94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad86a4e1cf8fdd8816ac991f89da6e44a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="BuildInfo_8hpp.html#ad86a4e1cf8fdd8816ac991f89da6e44a">CDPL_BUILD_TIME</a>&#160;&#160;&#160;202401250001</td></tr>
<tr class="memitem:ad86a4e1cf8fdd8816ac991f89da6e44a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="BuildInfo_8hpp.html#ad86a4e1cf8fdd8816ac991f89da6e44a">CDPL_BUILD_TIME</a>&#160;&#160;&#160;202401260000</td></tr>
<tr class="memdesc:ad86a4e1cf8fdd8816ac991f89da6e44a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <em>CDPL</em> build time in the format <em>YYYYMMDDHHMM</em>. <a href="BuildInfo_8hpp.html#ad86a4e1cf8fdd8816ac991f89da6e44a">More...</a><br /></td></tr>
<tr class="separator:ad86a4e1cf8fdd8816ac991f89da6e44a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
Expand Down Expand Up @@ -159,7 +159,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad86a4e1cf8fdd8816ac991f8
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CDPL_BUILD_TIME&#160;&#160;&#160;202401250001</td>
<td class="memname">#define CDPL_BUILD_TIME&#160;&#160;&#160;202401260000</td>
</tr>
</table>
</div><div class="memdoc">
Expand Down
2 changes: 1 addition & 1 deletion master/cdpl_api_doc/c++_api_doc/BuildInfo_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="BuildInfo_8hpp.html#a51e57b678c884de89185798ef6128d94"> 45</a></span>&#160;<span class="preprocessor">#define CDPL_BUILD_SYSTEM &quot;Linux-4.18.0-394.el8.x86_64&quot;</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="BuildInfo_8hpp.html#ad86a4e1cf8fdd8816ac991f89da6e44a"> 50</a></span>&#160;<span class="preprocessor">#define CDPL_BUILD_TIME 202401250001</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="BuildInfo_8hpp.html#ad86a4e1cf8fdd8816ac991f89da6e44a"> 50</a></span>&#160;<span class="preprocessor">#define CDPL_BUILD_TIME 202401260000</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif // CDPL_BUILDINFO_HPP</span></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCDPL_1_1Chem_1_1CIPConfigurationLabeler.html" title="CIPConfigurationLabeler.">CIPConfigurationLabeler</a>. </p>
<p>Code is largely based on a Java implementation of the CIP sequence rules by John Mayfield [<a class="el" href="References.html#CIPJM">CIPJM</a>]. </p>
<p>Code is largely based on a Java implementation of the CIP sequence rules by John Mayfield [<a class="el" href="References.html#CIPJM">CIPJM</a>]. </p><dl class="section since"><dt>Since</dt><dd>1.1 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a95723d445f0312a55d893e20f80730fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95723d445f0312a55d893e20f80730fa">&#9670;&nbsp;</a></span>getObjectID()</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides constants for the specification of stereogenic atom/bond configurations determined by the CIP sequence rules. </p>
<dl class="section since"><dt>Since</dt><dd>1.1 </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab031092cdb3c8762540af0d4

<p>Specifies the font used for atom configuration descriptor text labels. </p>
<p>The font specified by this property takes precedence over the fonts specified by <a class="el" href="classCDPL_1_1Vis_1_1ControlParameter.html#a93dd2fe07db0186599ee7e02bb6b30e9" title="Specifies the font used for atom configuration descriptor text labels.">Vis.ControlParameter.ATOM_CONFIGURATION_LABEL_FONT</a> and <a class="el" href="classCDPL_1_1Vis_1_1MolecularGraphProperty.html#a29bd3bec57db6e16cfb43eef8007af30" title="Specifies the font used for atom configuration descriptor text labels.">Vis.MolecularGraphProperty.ATOM_CONFIGURATION_LABEL_FONT</a>.</p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1Font.html" title="Specifies a font for drawing text.">Vis.Font</a> </p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1Font.html" title="Specifies a font for drawing text.">Vis.Font</a> </p><dl class="section since"><dt>Since</dt><dd>1.1 </dd></dl>

</div>
</div>
Expand All @@ -356,7 +356,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7f816db81b08864b6d038244

<p>Specifies the size of atom configuration descriptor text labels. </p>
<p>The size can either be specified as an absolute value or as a scaling factor for the primary label size given by <a class="el" href="classCDPL_1_1Vis_1_1ControlParameter.html#a644c563e689857225bfd57db033a197f" title="Specifies the size of atom element and query match expression labels.">Vis.ControlParameter.ATOM_LABEL_SIZE</a>, <a class="el" href="classCDPL_1_1Vis_1_1MolecularGraphProperty.html#aa749eb452d2d48fad8a6e288a7bd8cfb" title="Specifies the size of atom element and query match expression labels.">Vis.MolecularGraphProperty.ATOM_LABEL_SIZE</a> or <a class="el" href="classCDPL_1_1Vis_1_1AtomProperty.html#a78057cbae35b6fdd2cf8faa329dfafda" title="Specifies the size of atom element and query match expression labels.">Vis.AtomProperty.LABEL_SIZE</a>. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The specified size takes precedence over the size specified by the parameter <a class="el" href="classCDPL_1_1Vis_1_1ControlParameter.html#a9a5357ed6f211d161d9bc34d99223d32" title="Specifies the size of atom configuration descriptor text labels.">Vis.ControlParameter.ATOM_CONFIGURATION_LABEL_SIZE</a> and <a class="el" href="classCDPL_1_1Vis_1_1MolecularGraphProperty.html#aba31c727eab4032864e233cf6c95dda9" title="Specifies the size of atom configuration descriptor text labels.">Vis.MolecularGraphProperty.ATOM_CONFIGURATION_LABEL_SIZE</a>.</p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1SizeSpecification.html" title="Specifies the value and type of a size attribute and defines how the value may change during processi...">Vis.SizeSpecification</a> </p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1SizeSpecification.html" title="Specifies the value and type of a size attribute and defines how the value may change during processi...">Vis.SizeSpecification</a> </p><dl class="section since"><dt>Since</dt><dd>1.1 </dd></dl>

</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4a4b77374188ea1c969b6c6b

<p>Specifies the font used for bond configuration descriptor text labels. </p>
<p>The font specified by this property takes precedence over the fonts specified by <a class="el" href="classCDPL_1_1Vis_1_1ControlParameter.html#a2e396d0fbf6d0ec51cdd3e29f7456c9f" title="Specifies the font used for bond configuration descriptor text labels.">Vis.ControlParameter.BOND_CONFIGURATION_LABEL_FONT</a> and <a class="el" href="classCDPL_1_1Vis_1_1MolecularGraphProperty.html#af04506259be3c334c31e3b2c9c0b49fc" title="Specifies the font used for bond configuration descriptor text labels.">Vis.MolecularGraphProperty.BOND_CONFIGURATION_LABEL_FONT</a>.</p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1Font.html" title="Specifies a font for drawing text.">Vis.Font</a> </p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1Font.html" title="Specifies a font for drawing text.">Vis.Font</a> </p><dl class="section since"><dt>Since</dt><dd>1.1 </dd></dl>

</div>
</div>
Expand All @@ -510,7 +510,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9255e803304c75821ed949b2

<p>Specifies the size of bond configuration descriptor text labels. </p>
<p>The size can either be specified as an absolute value or as a scaling factor for the primary label size given by <a class="el" href="classCDPL_1_1Vis_1_1ControlParameter.html#a53842808efa1c9412af33363def878d8" title="Specifies the size of bond labels.">Vis.ControlParameter.BOND_LABEL_SIZE</a>, <a class="el" href="classCDPL_1_1Vis_1_1MolecularGraphProperty.html#a3b1fbaee6e7a98f18f9481e73312f5c2" title="Specifies the size of bond labels.">Vis.MolecularGraphProperty.BOND_LABEL_SIZE</a> or <a class="el" href="classCDPL_1_1Vis_1_1BondProperty.html#a41d69734dc5e148b5baca086d4fb361e" title="Specifies the size of bond labels.">Vis.BondProperty.LABEL_SIZE</a>. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The specified size takes precedence over the size specified by the parameter <a class="el" href="classCDPL_1_1Vis_1_1ControlParameter.html#ad54c013256a3a754fe4e74c8ffb63203" title="Specifies the size of bond configuration descriptor text labels.">Vis.ControlParameter.BOND_CONFIGURATION_LABEL_SIZE</a> and <a class="el" href="classCDPL_1_1Vis_1_1MolecularGraphProperty.html#ac6167104f07dfa32042bd1f69c1bc1b8" title="Specifies the size of bond configuration descriptor text labels.">Vis.MolecularGraphProperty.BOND_CONFIGURATION_LABEL_SIZE</a>.</p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1SizeSpecification.html" title="Specifies the value and type of a size attribute and defines how the value may change during processi...">Vis.SizeSpecification</a> </p>
<p><b>Value Type:</b> <a class="el" href="classCDPL_1_1Vis_1_1SizeSpecification.html" title="Specifies the value and type of a size attribute and defines how the value may change during processi...">Vis.SizeSpecification</a> </p><dl class="section since"><dt>Since</dt><dd>1.1 </dd></dl>

</div>
</div>
Expand Down
Loading

0 comments on commit 5583600

Please sign in to comment.