Added:

- Added mathematical notations to the constraint module.

Fixed:

- Fixed the format of the API reference.

doc/source/conf.py

@@ -46,18 +46,29 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
 # Sphinx extension module names and templates location
 sys.path.append(os.path.abspath("_extensions"))
 extensions = [
+    "sphinx.ext.autodoc",
     "sphinx_tabs.tabs",
     "notfound.extension",
     "sphinxext.opengraph",
     "sphinx.ext.todo",
     "sphinx.ext.ifconfig",
     "sphinx.ext.mathjax",
     "sphinxcontrib.bibtex",
-    "sphinx.ext.autodoc",
+    "sphinx_copybutton",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
+
+autodoc_typehints = 'description'
+
 # Specify the path to your BibTeX file
 bibtex_bibfiles = ['references.bib']
 
+# Enable Napoleon Google style docstrings
+# napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+
 # Warning when the Sphinx Tabs extension is used with unknown
 # builders (like the dummy builder) - as it doesn't cause errors,
 # we can ignore this so we still can treat other warnings as errors.

prepshot/_model/co2.py

@@ -1,36 +1,39 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-"""This module contains constraints related to carbon emissions. 
-"""
+"""This module contains the constraints and expressions related to
+carbon emissions. The model computes the carbon emissions for each year, 
+based on the sum of carbon emissions from each zone, and from each technology
+as follows:
+
+.. math::
+
+    {\\rm{carbon}}_y=\\sum_{e\\in\\mathcal{E}}\\sum_{z\\in\mathcal{Z}}
+    \\sum_{m\\in\mathcal{M}}\\sum_{h\\in\mathcal{H}}
+    \\left({{\\rm{CARBON}}}_{y,z,e}\\times 
+    {\\rm{gen}}_{h,m,y,z,e}\\right)\\quad\\forall y
 
-from typing import Union
+The calculated carbon emission for each year lower than its upper bound, as follows:
 
+.. math::
+    
+    {\\rm{carbon}}_y\\le{\\overline{{\\rm{CARBON}}}}_y\\quad\\forall y
+    
+"""
 import pyoptinterface as poi
 import numpy as np
 
 class AddCo2EmissionConstraints:
     """Class for carbon emission constraints and calculations.
     """
-    def __init__(self,
-        model : Union[
-            poi._src.highs.Model,
-            poi._src.gurobi.Model,
-            poi._src.mosek.Model,
-            poi._src.copt.Model
-        ],
-    ) -> None:
+    def __init__(self, model : object) -> None:
         """Initialize the class.
 
         Parameters
         ----------
-        model : Union[
-            poi._src.highs.Model,
-            poi._src.gurobi.Model,
-            poi._src.mosek.Model,
-            poi._src.copt.Model
-        ]
+        model : object
             Model object depending on the solver.
+
         """
         self.model = model
         model.carbon_breakdown = poi.make_tupledict(
@@ -50,10 +53,7 @@ def __init__(self,
             rule=self.emission_limit_rule
         )
 
-    def emission_limit_rule(
-        self,
-        y : int
-    ) -> poi._src.core_ext.ConstraintIndex:
+    def emission_limit_rule(self, y : int) -> poi.ConstraintIndex:
         """Annual carbon emission limits across all zones and technologies.
         
         Parameters
@@ -63,8 +63,8 @@ def emission_limit_rule(
             
         Returns
         -------
-        pyoptinterface._src.core_ext.ConstraintIndex
-            Constraint index of the model.
+        poi.ConstraintIndex
+            A constraint of the model.
         """
         model = self.model
         limit = model.params['carbon_emission_limit']
@@ -73,10 +73,7 @@ def emission_limit_rule(
         lhs = model.carbon[y] - limit[y]
         return model.add_linear_constraint(lhs, poi.Leq, 0)
 
-    def emission_calc_rule(
-        self,
-        y : int
-    ) -> poi._src.core_ext.ConstraintIndex:
+    def emission_calc_rule(self, y : int) -> poi.ConstraintIndex:
         """Calculation of annual carbon emission across all zones and
         technologies.
 
@@ -87,8 +84,8 @@ def emission_calc_rule(
 
         Returns
         -------
-        pyoptinterface._src.core_ext.ConstraintIndex
-            Constraint index of the model.
+        poi.ConstraintIndex
+            A constraint of the model.
         """
         model = self.model
         return poi.quicksum(
@@ -97,10 +94,8 @@ def emission_calc_rule(
         )
 
     def emission_calc_by_zone_rule(
-        self,
-        y : int,
-        z : str
-    ) -> poi._src.core_ext.ConstraintIndex:
+        self, y : int, z : str
+    ) -> poi.ConstraintIndex:
         """Calculation of annual carbon emissions by zone.
 
         Parameters
@@ -112,8 +107,8 @@ def emission_calc_by_zone_rule(
 
         Returns
         -------
-        pyoptinterface._src.core_ext.ConstraintIndex
-            Constraint index of the model.
+        poi.ConstraintIndex
+            A constraint of the model.
         """
         model = self.model
         return poi.quicksum(
@@ -126,7 +121,7 @@ def carbon_breakdown(
         y : int,
         z : str,
         te : str
-    ) -> poi._src.core_ext.ExprBuilder:
+    ) -> poi.ExprBuilder:
         """Carbon emission cost breakdown.
 
         Parameters
@@ -140,8 +135,8 @@ def carbon_breakdown(
 
         Returns
         -------
-        pyoptinterface._src.core_ext.ExprBuilder
-            index of expression of the model.
+        poi.ExprBuilder
+            The expression of the model.
         """
         model = self.model
         ef = model.params['emission_factor'][te, y]