Modernizing the docs and improving terminal output

.gitignore

@@ -134,29 +134,21 @@ dmypy.json
 # MacOS
 .DS_Store
 
-# DUNE
-dune-common/
-dune-geometry/
-dune-grid/
-dune-istl/
-
-# The OPM
-opm-common/
-opm-grid/
-opm-models/
-opm-simulators/
+# OPM
+dune-*
+opm-*
 
 # Extra folders
-examples/hello_world
-developing
-playground
-presentation
-debugging
-vexpreccs
-workshop
-cssr
-test_outputs
+/examples/hello_world
+/developing
+/playground
+/presentation
+/debugging
+/vexpreccs
+/workshop
+/cssr
+/test_outputs
 
 # Extra files
-regional_rpr-3.png
-reference_sgas_i,j,1_t90.png
+/regional_rpr-3.png
+/reference_sgas_i,j,1_t90.png

README.md

@@ -1,5 +1,5 @@
 [![Build Status](https://github.com/cssr-tools/expreccs/actions/workflows/CI.yml/badge.svg)](https://github.com/cssr-tools/expreccs/actions/workflows/CI.yml)
-<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.11%20to%203.14-blue.svg"></a>
+<a href="https://www.python.org/"><img src="https://img.shields.io/badge/python-3.12%20to%203.14-blue.svg"></a>
 [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![DOI](https://zenodo.org/badge/760077220.svg)](https://zenodo.org/doi/10.5281/zenodo.12100600)
@@ -20,15 +20,13 @@ To install the _expreccs_ executable in an existing Python environment:
 pip install git+https://github.com/cssr-tools/expreccs.git
 ```
 
-If you are interested in a specific version (e.g., v2026.04) or in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:
+If you are interested in in modifying the source code, then you can clone the repository and install the Python requirements in a virtual environment with the following commands:
 
 ```bash
 # Clone the repo
 git clone https://github.com/cssr-tools/expreccs.git
 # Get inside the folder
 cd expreccs
-# For a specific version (e.g., v2026.04), or skip this step (i.e., edge version)
-git checkout v2026.04
 # Create the virtual environment
 python3 -m venv vexpreccs
 # Activate the virtual environment

dev-requirements.txt

@@ -1,8 +1,12 @@
 black
+numpydoc
 mypy
+pydata_sphinx_theme
 pylint
 pytest-cov
 pytest-xdist
 ruff
 sphinx
+sphinx_copybutton
+sphinx_design
 sphinx-rtd-theme

docs/Makefile

@@ -1,25 +1,21 @@
-# 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     = text
 BUILDDIR      = _build
+APIDIR        = $(SOURCEDIR)/api
 
-# Put it first so that "make" without argument is like "make help".
+.PHONY: help clean api html linkcheck github
 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
-	sphinx-apidoc --private -e -f -o text ../src/expreccs
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-github:
-	@make html
-	cp -a _build/html/. .
+clean:
+	rm -rf "$(BUILDDIR)" "$(APIDIR)"
+api:
+	rm -rf "$(APIDIR)"
+	mkdir -p "$(APIDIR)"
+	sphinx-apidoc --private -e -f -o "$(APIDIR)" ../src/expreccs
+html: api
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+linkcheck: api
+	@$(SPHINXBUILD) -M linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+github: html
+	cp -a "$(BUILDDIR)/html/." .