JuliaDocs / Documenter.jl

A documentation generator for Julia.

Home Page:https://documenter.juliadocs.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

make.jl fails with git error

rkube opened this issue · comments

Hi,
I'm trying to generate documentation for my project following these instructions: https://documenter.juliadocs.org/stable/man/guide/

I created a docs subfolder with make.jl :

using Documenter
push!(LOAD_PATH,"../src/")
using my_package

makedocs(sitename="my_package Documentation")

When I run make.jl I get the following error:

*[main][~/julia_envs/my_package/docs]$ julia --color=yes --project make.jl 
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: /Users/ralphkube/julia_envs/my_package
Stacktrace:
 [1] interpret_repo_and_remotes(; root::String, repo::String, remotes::Dict{Any, Any})
   @ Documenter ~/.julia/packages/Documenter/1HwWe/src/documents.jl:640
 [2] interpret_repo_and_remotes
   @ ~/.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{Any}, 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::@Kwargs{})
   @ Documenter ~/.julia/packages/Documenter/1HwWe/src/documents.jl:429
 [4] #makedocs#81
   @ Documenter ~/.julia/packages/Documenter/1HwWe/src/makedocs.jl:242 [inlined]
 [5] top-level scope
   @ ~/julia_envs/my_package/docs/make.jl:5

The git configuration for my_package works fine though and git origin is set correctly.