Change docstring style to numpydocs (#901)

* Update half the docstrings to numpy style * Fix minor change bug * Introduce numpy style * Add new api reference style * Remove older style @p references * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Update src/pyscipopt/scip.pxi * Apply suggestions from code review * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update some comments from Joao * Update src/pyscipopt/scip.pxi Co-authored-by: João Dionísio <[email protected]> * Update src/pyscipopt/scip.pxi --------- Co-authored-by: João Dionísio <[email protected]>
scipopt · Sep 23, 2024 · 729420c · 729420c
1 parent a061b76
commit 729420c
Show file tree

Hide file tree

Showing 11 changed files with 4,767 additions and 1,159 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@
 - Fixed too strict getObjVal, getVal check
 ### Changed
 - Changed createSol to now have an option of initialising at the current LP solution
+- Unified documentation style of scip.pxi to numpydocs
 ### Removed
 
 ## 5.1.1 - 2024-06-22

diff --git a/docs/api.rst b/docs/api.rst
@@ -1,79 +1,86 @@
 #############
-API reference
+API Reference
 #############
 
 This page provides an auto-generated summary of PySCIPOpt's API.
 
+.. automodule:: pyscipopt
+
 SCIP Model
 ==========
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+This is the main class of PySCIPOpt. Most functionality is accessible through functions
+of this class. All functions that require the SCIP object belong to this class.
+
+.. toctree::
+  :maxdepth: 1
 
-  pyscipopt.Model
+  api/model
 
 SCIP Constraint
 ===============
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+This class wraps a SCIP constraint object. It contains functions that can retrieve basic information
+that is entirely contained within the constraint object.
+
+.. toctree::
+  :maxdepth: 1
 
-  pyscipopt.Constraint
+  api/constraint
 
 SCIP Variable
 =============
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+This class wraps a SCIP variable object. It contains functions that can retrieve basic information
+that is entirely contained within the variable object.
 
-  pyscipopt.Variable
+.. toctree::
+  :maxdepth: 1
+
+  api/variable
 
 SCIP Row
 ========
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+This class wraps a SCIP row object. It contains functions that can retrieve basic information
+that is entirely contained within the row object.
+
+.. toctree::
+  :maxdepth: 1
 
-  pyscipopt.scip.Row
+  api/row
 
 SCIP Column
 ===========
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+This class wraps a SCIP column object. It contains functions that can retrieve basic information
+that is entirely contained within the column object.
+
+.. toctree::
+  :maxdepth: 1
 
-  pyscipopt.scip.Column
+  api/column
 
 SCIP Node
 =========
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+This class wraps a SCIP node object. It contains functions that can retrieve basic information
+that is entirely contained within the node object.
 
-  pyscipopt.scip.Node
+.. toctree::
+  :maxdepth: 1
 
-SCIP Solution
-=============
-
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
-
-  pyscipopt.scip.Solution
+  api/node
 
 SCIP Event
-===========
+==========
+
+This class wraps a SCIP event object. It contains functions that can retrieve basic information
+that is entirely contained within the event object.
 
-.. autosummary::
-  :toctree: _autosummary
-  :recursive:
+.. toctree::
+  :maxdepth: 1
 
-  pyscipopt.scip.Event
+  api/event
 
 
diff --git a/docs/api/column.rst b/docs/api/column.rst
@@ -0,0 +1,6 @@
+##########
+Column API
+##########
+
+.. autoclass:: pyscipopt.scip.Column
+    :members:
diff --git a/docs/api/constraint.rst b/docs/api/constraint.rst
@@ -0,0 +1,6 @@
+##############
+Constraint API
+##############
+
+.. autoclass:: pyscipopt.Constraint
+    :members:
diff --git a/docs/api/event.rst b/docs/api/event.rst
@@ -0,0 +1,6 @@
+##########
+Event API
+##########
+
+.. autoclass:: pyscipopt.scip.Event
+    :members:
diff --git a/docs/api/model.rst b/docs/api/model.rst
@@ -0,0 +1,6 @@
+#########
+Model API
+#########
+
+.. autoclass:: pyscipopt.Model
+    :members:
diff --git a/docs/api/node.rst b/docs/api/node.rst
@@ -0,0 +1,6 @@
+########
+Node API
+########
+
+.. autoclass:: pyscipopt.scip.Node
+    :members:
diff --git a/docs/api/row.rst b/docs/api/row.rst
@@ -0,0 +1,6 @@
+#######
+Row API
+#######
+
+.. autoclass:: pyscipopt.scip.Row
+    :members:
diff --git a/docs/api/variable.rst b/docs/api/variable.rst
@@ -0,0 +1,6 @@
+############
+Variable API
+############
+
+.. autoclass:: pyscipopt.Variable
+    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -82,8 +82,9 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-autosummary_generate = True
-autoclass_content = "class"
+autosummary_generate = False
+napoleon_numpy_docstring = True
+napoleon_google_docstring = False
 
 pygments_style = "sphinx"