Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ If you are interested in a specific version (e.g., v2026.04) or in modifying the
git clone https://github.com/cssr-tools/plopm.git
# Get inside the folder
cd plopm
# For a specific version (e.g., v2026.04), or else skip this step (i.e., edge version)
git checkout v2026.04
# Create virtual environment
python3 -m venv vplopm
# Activate virtual environment
Expand Down
3 changes: 3 additions & 0 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@ black
numpydoc
mypy
pillow
pydata_sphinx_theme
pylint
pytest-cov
pytest-xdist
ruff
sphinx
sphinx_copybutton
sphinx_design
sphinx-rtd-theme
40 changes: 22 additions & 18 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
# Minimal makefile for Sphinx documentation
#
# Makefile for the plopm 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
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = text
BUILDDIR = _build
APIDIR = text/api

.PHONY: help clean api html linkcheck docs

# 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)"

api:
@mkdir -p "$(APIDIR)"
sphinx-apidoc -e -f -o "$(APIDIR)" ../src/plopm

html: api
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

# 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/plopm
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
linkcheck:
@$(SPHINXBUILD) -M linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

github:
@make html
cp -a _build/html/. .
# Preserve the repository's current publishing workflow when needed.
docs: html
cp -a "$(BUILDDIR)/html/." .
Binary file removed docs/_images/about.png
Binary file not shown.
Binary file removed docs/_images/docs_z_flag.png
Binary file not shown.
Binary file modified docs/_images/plopm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/sgas_beautiful.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11b_sgas_i,1,k_t5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11c_pressure_i,j,1:120_t2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11c_satnum_i,14,k_t2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11c_sgas_55,j,k_t2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11c_sgas_i,14,k_t2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11c_sgas_i,j,14_t2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/spe11c_temp.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading