From 6eaefc3eb547d848da7b19bd9090535d85c0962b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Legat?= Date: Sat, 16 Sep 2023 12:32:28 +0200 Subject: [PATCH 1/6] Update to Documenter v1 --- docs/Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Project.toml b/docs/Project.toml index 6c594cc34a..0c18617ad0 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -5,6 +5,6 @@ JSONSchema = "7d188eb4-7ad8-530c-ae41-71a32a6d4692" MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee" [compat] -Documenter = "0.27.10" +Documenter = "1" JSON = "0.21" JSONSchema = "1" From 1e0f39710f7f879a11698bbe843c0dc9315ad51f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Legat?= Date: Sun, 17 Sep 2023 22:33:10 +0200 Subject: [PATCH 2/6] Remove strict --- docs/make.jl | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index cca95433be..32f95cbbd1 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -130,7 +130,6 @@ end collapselevel = 1, ), clean = true, - strict = true, linkcheck = true, linkcheck_ignore = [ # Ignore the PDF link, because it hasn't been built yet. From 03a60f91a336a654b786402537a3406914fbd66b Mon Sep 17 00:00:00 2001 From: odow Date: Mon, 18 Sep 2023 10:06:12 +1200 Subject: [PATCH 3/6] Update --- .gitignore | 1 + docs/make.jl | 14 ++++++++++++++ 2 files changed, 15 insertions(+) diff --git a/.gitignore b/.gitignore index 1da8dace7b..dba455fa46 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ test/Benchmarks/*.json Manifest.toml *.swp docs/src/release_notes.md +docs/src/MathOptInterface.pdf diff --git a/docs/make.jl b/docs/make.jl index 32f95cbbd1..05921c293c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -120,6 +120,10 @@ end # Build the HTML docs # ============================================================================== +# Needed to make Documenter think that there is a PDF in the right place when +# link checking. Inn production we replace this by running the LaTeX build. +write(joinpath(@__DIR__, "src", "MathOptInterface.pdf"), "") + @time Documenter.makedocs( sitename = "MathOptInterface", authors = "The JuMP core developers and contributors", @@ -128,6 +132,16 @@ end prettyurls = get(ENV, "CI", nothing) == "true", mathengine = Documenter.MathJax2(), collapselevel = 1, + # Do no check for large pages. + size_threshold_ignore = [ + "changelog.md", + "release_notes.md", + "reference/models.md", + "reference/standard_form.md", + "submodules/Bridges/list_of_bridges.md", + "submodules/Bridges/reference.md", + "submodules/Utilities/reference.md", + ], ), clean = true, linkcheck = true, From 959cf5a9f15539aafd40bbbc20364575848fcc5b Mon Sep 17 00:00:00 2001 From: odow Date: Mon, 18 Sep 2023 10:41:44 +1200 Subject: [PATCH 4/6] Debug latex --- .github/workflows/documentation.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index a6ab731926..1123f295ba 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,7 +24,13 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key - run: julia --project=docs/ docs/make.jl + DOCUMENTER_LATEX_DEBUG: ${{ github.workspace }}/latex-debug-logs + run: julia --color=yes --project=docs/ docs/make.jl + - uses: actions/upload-artifact@v3 + if: ${{ always() }} + with: + name: PDF build logs + path: ${{ github.workspace }}/latex-debug-logs - uses: errata-ai/vale-action@reviewdog with: files: docs/src From 3bbe789122cd7d6d648c73848116d767e4208773 Mon Sep 17 00:00:00 2001 From: odow Date: Mon, 18 Sep 2023 11:08:19 +1200 Subject: [PATCH 5/6] Remove custom.sty --- docs/src/assets/custom.sty | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 docs/src/assets/custom.sty diff --git a/docs/src/assets/custom.sty b/docs/src/assets/custom.sty deleted file mode 100644 index ee34fc36de..0000000000 --- a/docs/src/assets/custom.sty +++ /dev/null @@ -1,7 +0,0 @@ -% Override the default styling of {minted} in LaTeX output -\usepackage{minted,xcolor} -\definecolor{codeblock-color}{gray}{0.96} -\definecolor{codeblock-color2}{gray}{0.8} -\setminted{bgcolor=codeblock-color,frame=none} -\lstset{rulecolor=\color{codeblock-color2},frame=single} -% From b7b3ee6f5d78fe0409a14f6553d54e8c4d701f46 Mon Sep 17 00:00:00 2001 From: Oscar Dowson Date: Mon, 18 Sep 2023 11:47:11 +1200 Subject: [PATCH 6/6] Update make.jl --- docs/make.jl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index 05921c293c..c17691ed5c 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -181,7 +181,8 @@ if _PDF # includes lots of extraneous LaTeX files. cp( joinpath(@__DIR__, "latex_build", "MathOptInterface.pdf"), - joinpath(@__DIR__, "build", "MathOptInterface.pdf"), + joinpath(@__DIR__, "build", "MathOptInterface.pdf"); + force = true, ) end