Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to Documenter v1 #2266

Merged
merged 6 commits into from
Sep 18, 2023
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ test/Benchmarks/*.json
Manifest.toml
*.swp
docs/src/release_notes.md
docs/src/MathOptInterface.pdf
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
18 changes: 16 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -128,9 +132,18 @@ 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,
strict = true,
linkcheck = true,
linkcheck_ignore = [
# Ignore the PDF link, because it hasn't been built yet.
Expand Down Expand Up @@ -168,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

Expand Down
7 changes: 0 additions & 7 deletions docs/src/assets/custom.sty

This file was deleted.