Skip to content

[docs] update to Documenter@1 and Clang@0.19 - #3229

Merged
galabovaa merged 1 commit into
latestfrom
od/update-docs
Aug 26, 2026
Merged

[docs] update to Documenter@1 and Clang@0.19#3229
galabovaa merged 1 commit into
latestfrom
od/update-docs

Conversation

@odow

@odow odow commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR updates the documentation build to use Documenter@1 and Clang@0.19

Preview link: https://ergo-code.github.io/HiGHS/previews/PR3229/

Checklist

  • I have read the contributing guidelines
  • This PR targets the latest branch
  • Tests are passing
  • Documentation was updated where relevant
  • This PR is not primarily AI-generated (per the AI contributions policy in CONTRIBUTING.md)

Comment thread .github/workflows/documentation.yml Outdated
@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.21%. Comparing base (c32911c) to head (3750126).
⚠️ Report is 39 commits behind head on latest.

Additional details and impacted files
@@            Coverage Diff             @@
##           latest    #3229      +/-   ##
==========================================
+ Coverage   73.15%   73.21%   +0.05%     
==========================================
  Files         445      445              
  Lines      108018   107993      -25     
  Branches    17313    17316       +3     
==========================================
+ Hits        79024    79069      +45     
+ Misses      28718    28648      -70     
  Partials      276      276              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread .github/workflows/documentation.yml Outdated
Comment thread docs/c_api_gen/generate.toml Outdated
@filikat

filikat commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Thanks! Now it works (after updating Julia), but only if I compile from the HiGHS folder. If I compile from docs, it fails with LoadError: SystemError: opening file "docs/c_api_gen/libhighs.jl": No such file or directory. The path to libhighs.jl assumes that you are in the HiGHS folder, but the instructions in the README to compile the docs assume that you are in docs.

@jajhall

jajhall commented Aug 25, 2026

Copy link
Copy Markdown
Member

Unless it's viewed as a breaking change, I wouldn't mind changing the documentation. Then building docs is done from the same place as building HiGHS and pip install

@odow

odow commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator Author

This will now work from any directory. The README was also missing --project.

@filikat

filikat commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

It works if I run just julia docs/make.jl. However, if I add --project=docs or I run julia --project=docs -e 'using Pkg; Pkg.instantiate()', I get the error

Failed to precompile Clang [40e3b903-d033-50b4-a0cc-940c62c95e31] to "/Users/filippozanetti/.julia/compiled/v1.12/Clang/jl_Pr8DMy".
ERROR: LoadError: UndefVarError: `libclang` not defined in `Clang.LibClang`
Suggestion: check for spelling errors or missing imports.
Stacktrace:
  [1] clang_getClangVersion
    @ ~/.julia/packages/Clang/kqsoL/lib/18/LibClang.jl:5835 [inlined]
  [2] version()
    @ Clang ~/.julia/packages/Clang/kqsoL/src/Clang.jl:77
  [3] top-level scope
    @ ~/.julia/packages/Clang/kqsoL/src/Clang.jl:84
  [4] include(mod::Module, _path::String)
    @ Base ./Base.jl:306
  [5] include_package_for_output(pkg::Base.PkgId, input::String, depot_path::Vector{String}, dl_load_path::Vector{String}, load_path::Vector{String}, concrete_deps::Vector{Pair{Base.PkgId, UInt128}}, source::Nothing)
    @ Base ./loading.jl:3106
  [6] top-level scope
    @ stdin:5
  [7] eval(m::Module, e::Any)
    @ Core ./boot.jl:489
  [8] include_string(mapexpr::typeof(identity), mod::Module, code::String, filename::String)
    @ Base ./loading.jl:2952
  [9] include_string
    @ ./loading.jl:2962 [inlined]
 [10] exec_options(opts::Base.JLOptions)
    @ Base ./client.jl:315
 [11] _start()
    @ Base ./client.jl:550

@odow

odow commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator Author

Delete the Manifest.toml. You’ve got the old mix of versions installed. If it works without project it’s because you have something installed in your global project.

start julia --project=docs

then type ] to enter the package manager, st to see what versions are installed, update or resolve to update.

(base) odow@Mac HiGHS % julia --project=docs
               _
   _       _ _(_)_     |  Documentation: https://docs.julialang.org
  (_)     | (_) (_)    |
   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 1.12.7 (2026-08-15)
 _/ |\__'_|_|_|\__'_|  |  Official https://julialang.org release
|__/                   |

(docs) pkg> st
Status `~/git/ERGO-Code/HiGHS/docs/Project.toml`
  [40e3b903] Clang v0.19.3
  [e30172f5] Documenter v1.17.0

(docs) pkg> update
    Updating registry at `~/.julia/registries/General.toml`
     Project No packages added to or removed from `~/git/ERGO-Code/HiGHS/docs/Project.toml`
    Manifest No packages added to or removed from `~/git/ERGO-Code/HiGHS/docs/Manifest.toml`

(docs) pkg> 

@filikat

filikat commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Thanks, now everything works

@galabovaa
galabovaa self-requested a review August 26, 2026 12:17

@galabovaa galabovaa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@galabovaa

Copy link
Copy Markdown
Contributor

Thank you!

@galabovaa
galabovaa merged commit 90ba7e9 into latest Aug 26, 2026
536 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants