Skip to content

Commit

Permalink
Debug ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
longxf21 committed Jun 7, 2024
1 parent f2f3f97 commit 0baf8fe
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
21 changes: 12 additions & 9 deletions docs/source/API.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
API Documentation
=================

Analyzer
--------
check_model Function
--------------------

.. autoclass:: ratesb_python.analyzer.Analyzer
:members:
:undoc-members:
:show-inheritance:

.. automethod:: check_model(model_str: str, rate_law_classifications_path: str=None, abort_on_complicated_rate_laws: bool=True, excluded_codes: List[int]=[])
.. automethod:: analyzer.check_model(model_str: str, rate_law_classifications_path: str=None, abort_on_complicated_rate_laws: bool=True, excluded_codes: List[int]=[])

Checks the SBML model for rate law errors and warnings.

Expand All @@ -24,6 +19,14 @@ Analyzer

The results of the checks as a result object, can be printed or converted to string.

Analyzer
--------

.. autoclass:: analyzer.Analyzer
:members:
:undoc-members:
:show-inheritance:

.. automethod:: list_all_checks()

Returns a string representation of all the checks.
Expand Down Expand Up @@ -100,7 +103,7 @@ Analyzer
Results
-------

.. autoclass:: ratesb_python.results.Results
.. autoclass:: results.Results
:members:
:undoc-members:
:show-inheritance:
Expand Down
1 change: 1 addition & 0 deletions docs/source/check_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ SBOTerm Annotations
- **Description**: The annotation for Michaelis-Menten kinetics with an explicit enzyme does not follow recommended SBO terms.
- **Example**: Incorrect SBO term used for Michaelis-Menten kinetics with an explicit enzyme.
- **Solution**: Use the recommended SBO term for Michaelis-Menten kinetics with an explicit enzyme.

For more details about warnings and errors, please refer to the "View Error Codes" button in `RateSB`_.

.. _RateSB: https://sys-bio.github.io/ratesb/

0 comments on commit 0baf8fe

Please sign in to comment.