doc: minor changes

vsdp · Jan 12, 2022 · eaa0590 · eaa0590
1 parent 01a9b3b
commit eaa0590
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 10 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -24,7 +24,6 @@ $(TARGET_LATEX): $(SRC)
 
 $(TARGET_PDF): $(SRC)
 	sed -i 's/\\begin{split}\\tag\*{\$$\\Box\$$}\\end{split}/\\tag\*{\$$\\Box\$$}/g' $(TARGET_LATEX)
-	sed -i '/^\\setmainlanguage.*/i \\\\usepackage{xeCJK}\n\\setCJKmainfont{IPAMincho}\n\\setCJKsansfont{IPAGothic}\n\\setCJKmonofont{IPAGothic}' $(TARGET_LATEX)
 	cd $(TARGET_LATEX_DIR) && $(MAKE)
 
 publish: $(TARGET_HTML)

diff --git a/doc/_config.yml b/doc/_config.yml
@@ -1,7 +1,7 @@
 # Book settings
 # Learn more at https://jupyterbook.org/customize/config.html
 
-title: "VSDP manual"
+title: "VSDP 2020 manual"
 author: "C. Jansson et al."
 copyright: "2018-2022"
 logo: "res/sdp_cone.png"

diff --git a/doc/_toc.yml b/doc/_toc.yml
@@ -1,7 +1,7 @@
 format: jb-book
 root: s00_getting_started.ipynb
 parts:
-  - caption: Contents
+  - caption: Manual
     chapters:
     - file: s01_installation.ipynb
     - file: s02_conic_programming.ipynb
@@ -16,4 +16,6 @@ parts:
     chapters:
     - file: s09_numerical_results.ipynb
     - file: s10_conic_solvers.ipynb
+    # For PDF move section of s11_references.ipynb
+    # into previous file, to avoid double header.
     - file: s11_references.ipynb
diff --git a/doc/s00_getting_started.ipynb b/doc/s00_getting_started.ipynb
@@ -6,6 +6,11 @@
    "source": [
     "# Getting started\n",
     "\n",
+    "Latest version of this manual <https://vsdp.github.io>\n",
+    "or <https://vsdp.github.io/vsdp-2020-manual.pdf>.\n",
+    "\n",
+    "## Abstract\n",
+    "\n",
     "**VSDP (Verified SemiDefinite-quadratic-linear Programming)** is a software\n",
     "package for the computation of verified results in conic programming.\n",
     "It supports the constraint cone consisting of the product of semidefinite cones,\n",
@@ -30,7 +35,7 @@
    "metadata": {},
    "source": [
     "The latest version of VSDP provides easy access to the\n",
-    "[conic solvers](s10_conic_solvers.ipynb):\n",
+    "[conic solvers](conic_solvers):\n",
     "- [CSDP](https://github.com/coin-or/Csdp),\n",
     "  [GLPK](https://www.gnu.org/software/glpk),\n",
     "  [LINPROG](https://www.mathworks.com/help/optim/ug/linprog.html),\n",
@@ -67,6 +72,7 @@
     "## Contributors\n",
     "\n",
     "- [Christian Jansson](https://www.tuhh.de/ti3/jansson/)\n",
+    "  (<[email protected]>)\n",
     "- Marko Lange (<[email protected]>)\n",
     "- Viktor Härter\n",
     "- Kai Torben Ohlhus (<[email protected]>)"

diff --git a/doc/s01_installation.ipynb b/doc/s01_installation.ipynb
@@ -51,8 +51,7 @@
     "[`vsdp-2020-master.zip`](https://github.com/vsdp/vsdp-2020/archive/refs/heads/master.zip)\n",
     "and extract it to an arbitrary location.\n",
     "\n",
-    "Legacy versions of VSDP are available from\n",
-    "<http://www.ti3.tu-harburg.de/jansson/vsdp/>.\n",
+    "Legacy versions of VSDP are available from <https://www.tuhh.de/ti3/software/>.\n",
     "\n",
     "### Using git\n",
     "\n",

diff --git a/doc/s02_conic_programming.ipynb b/doc/s02_conic_programming.ipynb
@@ -180,8 +180,7 @@
     "free variables are converted into the difference of non-negative variables.\n",
     "Besides the major disadvantage that this transformation is numerical unstable,\n",
     "it also increases the number of variables of the particular problems.\n",
-    "In VSDP [free variables](s08_free_variables.ipynb)\n",
-    "can be handled in a numerical stable manner."
+    "In VSDP [free variables](free_variables) can be handled in a numerical stable manner."
    ]
   },
   {
@@ -291,7 +290,7 @@
    "metadata": {},
    "source": [
     "$$\n",
-    "\\begin{align}\n",
+    "\\begin{aligned}\n",
     "\\mathcal{K} &:=&\n",
     "\\mathbb{R}^{n_{f}} &\\times\n",
     "\\mathbb{R}^{n_{l}}_{+} \\times\n",
@@ -302,7 +301,7 @@
     "\\mathbb{R}^{n_{l}}_{+} \\times\n",
     "\\mathbb{L}^{q_{1}} \\times \\ldots \\times \\mathbb{L}^{q_{n_{q}}} \\times\n",
     "\\mathbb{S}^{s_{1}}_{+} \\times \\ldots \\times \\mathbb{S}^{s_{n_{s}}}_{+}.\n",
-    "\\end{align}\n",
+    "\\end{aligned}\n",
     "$$"
    ]
   },

diff --git a/doc/s08_free_variables.ipynb b/doc/s08_free_variables.ipynb
@@ -19,6 +19,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "(free_variables)=\n",
     "# Free Variables\n",
     "\n",
     "Free variables often occur in practice.\n",

diff --git a/doc/s10_conic_solvers.ipynb b/doc/s10_conic_solvers.ipynb
@@ -4,6 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "(conic_solvers)=\n",
     "# Conic solvers\n",
     "\n",
     "In this section we provide some notes about our usage experience with VSDP\n",