Skip to content
Snippets Groups Projects
Commit aed6b51b authored by Martin Larralde's avatar Martin Larralde
Browse files

Fix some remaining issues in Sphinx documentation [ci skip]

parent 6523fb9a
No related branches found
No related tags found
No related merge requests found
Memory Errors Memory Errors
------------- -------------
.. currentmodule:: pyhmmer.errors
.. autoexception:: AllocationError(MemoryError) .. autoexception:: AllocationError(MemoryError)
:special-members: __init__ :special-members: __init__
:members: :members:
Runtime Errors Runtime Errors
-------------- --------------
.. currentmodule:: pyhmmer.errors
.. autoexception:: UnexpectedError(RuntimeError) .. autoexception:: UnexpectedError(RuntimeError)
:special-members: __init__ :special-members: __init__
:members: :members:
...@@ -11,4 +13,4 @@ Runtime Errors ...@@ -11,4 +13,4 @@ Runtime Errors
.. autoexception:: ServerError(RuntimeError) .. autoexception:: ServerError(RuntimeError)
:special-members: __init__ :special-members: __init__
:members: :members:
\ No newline at end of file
Value Errors Value Errors
------------ ------------
.. currentmodule:: pyhmmer.errors
.. autoexception:: AlphabetMismatch(ValueError) .. autoexception:: AlphabetMismatch(ValueError)
:special-members: __init__ :special-members: __init__
...@@ -16,4 +17,4 @@ Value Errors ...@@ -16,4 +17,4 @@ Value Errors
.. autoexception:: InvalidParameter(ValueError) .. autoexception:: InvalidParameter(ValueError)
:special-members: __init__ :special-members: __init__
:members: :members:
\ No newline at end of file
Iterative Searches Iterative Searches
================== ==================
.. autofunction:: pyhmmer.hmmer.jackhmmer(queries, sequences, cpus=0, allback=None, builder=None, max_iterations=5, select_hits=None, checkpoints=False, **options) .. currentmodule:: pyhmmer.hmmer
.. autofunction:: pyhmmer.hmmer.jackhmmer(queries, sequences, *, max_iterations=5, select_hits=None, checkpoints=False, cpus=0, callback=None, builder=None, **options)
...@@ -190,6 +190,8 @@ napoleon_use_rtype = False ...@@ -190,6 +190,8 @@ napoleon_use_rtype = False
autoclass_content = "class" autoclass_content = "class"
autodoc_member_order = 'groupwise' autodoc_member_order = 'groupwise'
autosummary_generate = [] autosummary_generate = []
autodoc_typehints = 'none'
autodoc_class_signature = 'separated'
# -- Options for intersphinx extension --------------------------------------- # -- Options for intersphinx extension ---------------------------------------
......
...@@ -13,7 +13,7 @@ examples, and running with the latest version of the PyHMMER interface. ...@@ -13,7 +13,7 @@ examples, and running with the latest version of the PyHMMER interface.
Build an HMM from an multiple sequence alignment <msa_to_hmm> Build an HMM from an multiple sequence alignment <msa_to_hmm>
Analyse the active site of an enzymatic domain <active_site> Analyse the active site of an enzymatic domain <active_site>
Fetch Marker Genes from a genome <fetchmgs> Fetch marker genes from a genome <fetchmgs>
Run an iterative search to build a HMM for rhodopsins <iterative_search> Run an iterative search to build a HMM for rhodopsins <iterative_search>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment