search

TulipaEnergy / TulipaEnergyModel.jl

An energy system optimization model that is flexible, computationally efficient, and academically robust.
Apache License 2.0
22 stars 19 forks source link

[BUG] - Can't build documentation locally #478

Closed gnawin closed 7 months ago

gnawin commented 7 months ago

Description

I followed the descriptions here https://github.com/TulipaEnergy/TulipaEnergyModel.jl/blob/main/README.dev.md.

Here is the error:

julia> include("make.jl")
[ Info: Precompiling TulipaEnergyModel [5d7bd171-d18e-45a5-9111-f1f11ac5d04d]
ERROR: LoadError: ArgumentError: Unable to automatically determine remote for main repo.
> `repo` is not set, and the Git repository has invalid origin.
Configure `repo` and/or `remotes` appropriately, or set `remotes = nothing` to disable remote source
links altogether (e.g. if not working in a Git repository).
  path: C:\Users\wangn\OneDrive - TNO\Repositories\TulipaEnergyModel.jl
Stacktrace:
 [1] interpret_repo_and_remotes(; root::String, repo::String, remotes::Dict{Any, Any})
   @ Documenter C:\Users\wangn\.julia\packages\Documenter\1HwWe\src\documents.jl:640
 [2] interpret_repo_and_remotes
   @ C:\Users\wangn\.julia\packages\Documenter\1HwWe\src\documents.jl:499 [inlined]
 [3] Documenter.Document(; root::String, source::String, build::String, workdir::Symbol, format::Documenter.HTMLWriter.HTML, clean::Bool, doctest::Bool, linkcheck::Bool, linkcheck_ignore::Vector{Any}, linkcheck_timeout::Int64, checkdocs::Symbol, doctestfilters::Vector{Regex}, warnonly::Vector{Symbol}, modules::Vector{Module}, pages::Vector{Pair{String, String}}, pagesonly::Bool, expandfirst::Vector{String}, plugins::Vector{Documenter.Plugin}, repo::String, remotes::Dict{Any, Any}, sitename::String, authors::String, version::String, highlightsig::Bool, draft::Bool, others::Base.Pairs{Symbol, Union{}, Tuple{}, NamedTuple{(), Tuple{}}})
   @ Documenter C:\Users\wangn\.julia\packages\Documenter\1HwWe\src\documents.jl:429
 [4] #makedocs#81
   @ C:\Users\wangn\.julia\packages\Documenter\1HwWe\src\makedocs.jl:242 [inlined]
 [5] top-level scope
   @ C:\Users\wangn\OneDrive - TNO\Repositories\TulipaEnergyModel.jl\docs\make.jl:6
 [6] include(fname::String)
   @ Base.MainInclude .\client.jl:478
 [7] top-level scope
   @ REPL[3]:1
in expression starting at C:\Users\wangn\OneDrive - TNO\Repositories\TulipaEnergyModel.jl\docs\make.jl:6

Reproduction steps

It seems that this error only occurs on my machine, at least Abel can't reproduce it.

Logs

No response

OS

No response

gnawin commented 7 months ago

This probably relates to the fact that I don't have any remote called origin. Adding the repo keyword to makedocs solves this bug.