Move user guide to ReadTheDocs

acroucher · Feb 19, 2024 · b0c15a3 · b0c15a3
1 parent 892cc32
commit b0c15a3
Show file tree

Hide file tree

Showing 33 changed files with 10,251 additions and 12,342 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,21 @@
+# File: .readthedocs.yaml
+
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+  install:
+    - requirements: doc/source/requirements.txt
+
+formats:
+  - pdf
+  - epub
diff --git a/doc/IAPWS97.tex b/doc/IAPWS97.tex
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = PyTOUGH
+SOURCEDIR     = source
+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)
diff --git a/doc/PyTOUGH-guide.pdf b/doc/PyTOUGH-guide.pdf
diff --git a/doc/PyTOUGH-guide.tex b/doc/PyTOUGH-guide.tex