Modernizing the docs and terminal output

.github/workflows/ci_pycopm_docker.yml

@@ -1,9 +1,7 @@
 name: Docker
 
 on:
- push:
-   branches:
-     - main
+ pull_request:
 
 jobs:
   run-pycopm-docker:

.gitignore

@@ -165,25 +165,18 @@ cython_debug/
 # Python environment
 vpycopm/
 
-# DUNE
-dune-common/
-dune-geometry/
-dune-grid/
-dune-istl/
-
-# The OPM
-opm-common/
-opm-grid/
-opm-simulators/
+# OPM
+dune-*
+opm-*
 
 # pycopm
-cssr/
-developing/
-examples/configurations/drogon/drogon_coarser
-test_outputs/
-playground/
-presentation/
-prototyping/
-project/
-studies/
+/cssr/
+/developing/
+/examples/configurations/drogon/drogon_coarser
+/test_outputs/
+/playground/
+/presentation/
+/prototyping/
+/project/
+/studies/
 .vscode/

README.md

@@ -21,15 +21,13 @@ To install the _pycopm_ executable from the development version:
 pip install git+https://github.com/cssr-tools/pycopm.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 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/pycopm.git
 # Get inside the folder
 cd pycopm
-# For a specific version (e.g., v2026.04), or skip this step (i.e., edge version)
-git checkout v2026.04
 # Create virtual environment (to specific Python, python3.13 -m venv vpycopm)
 python3 -m venv vpycopm
 # Activate virtual environment

dev-requirements.txt

@@ -1,8 +1,12 @@
-black<=26.5.1
-mypy<=2.3.1
-pylint<=4.0.7
-pytest-cov<=7.1.0
-pytest-xdist<=3.8.0
-ruff<=0.16.4
-sphinx<=9.1.0
-sphinx-rtd-theme<=3.1.0
+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,26 @@
-# Minimal makefile for Sphinx documentation
-#
+SPHINXOPTS  ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR    = text
+BUILDDIR     = _build
+APIDIR       = text/api
 
-# 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
+.PHONY: help clean api html linkcheck github
 
-# Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+clean:
+	rm -rf "$(BUILDDIR)"
 
-# 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/pycopm
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+api:
+	@mkdir -p "$(APIDIR)"
+	sphinx-apidoc --private -e -f -o "$(APIDIR)" ../src/pycopm
 
-github:
-	@make html
-	cp -a _build/html/. .
+html: api
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+linkcheck:
+	@$(SPHINXBUILD) -M linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+github: html
+	cp -a "$(BUILDDIR)/html/." .