From 0baf8fea1e48463229372c7f81c3213453c38961 Mon Sep 17 00:00:00 2001 From: Aldrich Fan Date: Fri, 7 Jun 2024 21:06:55 +0800 Subject: [PATCH] Debug ReadTheDocs --- docs/source/API.rst | 21 ++++++++++++--------- docs/source/check_reference.rst | 1 + 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/source/API.rst b/docs/source/API.rst index 9a14c8b..bbf4921 100644 --- a/docs/source/API.rst +++ b/docs/source/API.rst @@ -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. @@ -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. @@ -100,7 +103,7 @@ Analyzer Results ------- -.. autoclass:: ratesb_python.results.Results +.. autoclass:: results.Results :members: :undoc-members: :show-inheritance: diff --git a/docs/source/check_reference.rst b/docs/source/check_reference.rst index 687890c..50e3e9a 100644 --- a/docs/source/check_reference.rst +++ b/docs/source/check_reference.rst @@ -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/ \ No newline at end of file