Migrate to Readthedocs and Sphinx

.gitignore

@@ -81,6 +81,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/_autosummary/
 
 # PyBuilder
 target/

CHANGELOG.md

@@ -11,9 +11,15 @@
   SCIPgetVarStrongbranchLast, SCIPgetVarStrongbranchNode, SCIPallColsInLP, SCIPcolGetAge
 - Added getBipartiteGraphRepresentation
 - Added helper functions that facilitate testing
+- Added Python definitions and wrappers for SCIPgetNImplVars, SCIPgetNContVars, SCIPvarMayRoundUp,
+  SCIPvarMayRoundDown, SCIPcreateLPSol, SCIPfeasFloor, SCIPfeasCeil, SCIPfeasRound, SCIPgetPrioChild,
+  SCIPgetPrioSibling
+- Added additional tests to test_nodesel, test_heur, and test_strong_branching
+- Migrated documentation to Readthedocs
 ### Fixed
 - Fixed too strict getObjVal, getVal check
 ### Changed
+- Changed createSol to now have an option of initialising at the current LP solution
 ### Removed
 
 ## 5.1.1 - 2024-06-22

README.md

@@ -17,6 +17,17 @@ Please consult the [online documentation](https://scipopt.github.io/PySCIPOpt/do
 
 See [CHANGELOG.md](https://github.com/scipopt/PySCIPOpt/blob/master/CHANGELOG.md) for added, removed or fixed functionality.
 
+You can also build the documentation locally with the command
+```shell
+pip install -r docs/requirements.txt
+sphinx-build docs docs/_build
+```
+Às the documentation requires additional python packages, one should run the following command
+before building the documentation for the first time:
+```shell
+(venv) pip install -r docs/requirements.txt
+```
+
 Installation
 ------------
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

@@ -0,0 +1,79 @@
+#############
+API reference
+#############
+
+This page provides an auto-generated summary of PySCIPOpt's API.
+
+SCIP Model
+==========
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.Model
+
+SCIP Constraint
+===============
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.Constraint
+
+SCIP Variable
+=============
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.Variable
+
+SCIP Row
+========
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.scip.Row
+
+SCIP Column
+===========
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.scip.Column
+
+SCIP Node
+=========
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.scip.Node
+
+SCIP Solution
+=============
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.scip.Solution
+
+SCIP Event
+===========
+
+.. autosummary::
+  :toctree: _autosummary
+  :recursive:
+
+  pyscipopt.scip.Event
+
+