docs: test :class:ClassName

shahcompbio · Jun 11, 2024 · fadf4aa · fadf4aa
1 parent 6d38235
commit fadf4aa
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 3 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/ontmont.doctree b/docs/_build/doctrees/ontmont.doctree
diff --git a/docs/_build/html/ontmont.html b/docs/_build/html/ontmont.html
@@ -515,7 +515,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dd><p>Get SV type string for a given <code class="docutils literal notranslate"><span class="pre">BreakpointPair</span></code></p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>tra</strong> (<code class="docutils literal notranslate"><span class="pre">BreakpointPair</span></code>) – Paired breakpoint object</p>
+<dd class="field-odd"><p><strong>tra</strong> (:class:<code class="docutils literal notranslate"><span class="pre">BreakpointPair</span></code>) – Paired breakpoint object</p>
 </dd>
 <dt class="field-even">Raises<span class="colon">:</span></dt>
 <dd class="field-even"><p><strong>ValueError</strong> – If no SV type has been assigned</p>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,6 +22,8 @@
     'myst_parser',
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
+    'sphinx.ext.viewcode',
 ]
 
 # Napoleon settings

diff --git a/ontmont/collect.py b/ontmont/collect.py
@@ -203,7 +203,7 @@ def get_svtype(tra:BreakpointPair):
     """Get SV type string for a given ``BreakpointPair``
 
     Args:
-        tra (``BreakpointPair``): Paired breakpoint object
+        tra (:class:``BreakpointPair``): Paired breakpoint object
 
     Raises:
         ValueError: If no SV type has been assigned

diff --git a/requirements.txt b/requirements.txt
@@ -11,5 +11,6 @@ PyYAML
 scipy
 setuptools
 sphinxcontrib-napoleon
+sphinx-autodoc-typehints
 swalign
 tqdm