MindTheGap-ERC / CarboKitten.jl

Julia implementation of carbonate platform model
https://mindthegap-erc.github.io/CarboKitten.jl/
GNU General Public License v3.0
0 stars 0 forks source link

Warning from include("docs/make.jl"), this is the third command from the documentation section of the README #32

Closed HannoSpreeuw closed 3 months ago

HannoSpreeuw commented 3 months ago

Following the instructions from the README, these work well.

But I do get a warning when running include("docs/make.jl").

julia> include("docs/make.jl")
--->
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
┌ Warning: Documenter could not auto-detect the building environment Skipping deployment.
└ @ Documenter ~/.julia/packages/Documenter/9kOxY/src/deployconfig.jl:76

This is the third command from the documentation section.

HannoSpreeuw commented 3 months ago

After consulting @jhidding : This is what it should be, i.e. the warning should appear since you don't want to generate new GH pages from local updates. GH Actions should take care of updating GH pages.

I will add a remark to the README, to explain the warning.