Update the documentation on Projections

[yeesian]

trafficstars

We should update https://github.com/yeesian/ArchGDAL.jl/blob/master/docs/src/projections.md with the recent updates with GeoFormat and #120.

[visr]

Docs haven't been building since mentioned PR, because we have strict = true, so these warnings were turned into errors:

┌ Error: 4 docstrings potentially missing:
│
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:GeoFormatTypes.GeoFormat,Union{Type{GeoFormatTypes.FormatMode}, GeoFormatTypes.FormatMode},GeoFormatTypes.GeoFormat}
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:ArchGDAL.AbstractGeometry,GeoFormatTypes.AbstractWellKnownText}
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:GeoFormatTypes.AbstractWellKnownText,ArchGDAL.AbstractGeometry}
│     Base.convert :: Tuple{Type{var"#s134"} where var"#s134"<:GeoFormatTypes.GeoFormat,Union{GeoFormatTypes.CRS,Type{GeoFormatTypes.CRS}},GeoFormatTypes.GeoFormat}
└ @ Documenter.DocChecks C:\Users\visser_mn\.julia\packages\Documenter\bRylW\src\DocChecks.jl:66

I'm not sure how to fix them. The docstrings that were actually there in convert.jl caused these errors (not their absence). I had to choose between setting strict = false and allowing issues to creep in, or keep it strict, and disable the docstrings by putting a newline between them and the function definitions. I went for the latter for now. So @rafaqz if you wonder where your Base.convert docstrings went, they are still in the file, but not as docstrings.

Actually we probably should update our setup such that CI is red if the docs don't build, to prevent getting stuck with old builds.

[visr]

@yeesian in the new Documenter.jl a canonical url should be given, which I believe also helps SEO; which do you prefer:

• canonical = "https://yeesian.com/ArchGDAL.jl"
• canonical = "https://yeesian.github.io/ArchGDAL.jl" I assume yeesian.com since that is what it jumps to right now, but just making sure.

[yeesian]

Hey Martjin! Regarding the canonical url, I personally don't have a preference -- this package is becoming pretty community-driven, so we might prefer for it be based on github's domain, so that the switch to JuliaGeo (if we might prefer it) might not come across so jarringly to users browsing the documentation? I'll be happy either way -- let me know what you think.

[visr]

I think either way is fine. If we do yeesian.com and do move the package over to JuliaGeo later, we should put in automatic forwarding similar to how it would be done on the GitHub url, such that old links will still work. As long as that can be done, it should give no issues at all. Though perhaps even that will be automatic, since the site is still hosted on GitHub servers, which will forward as well.

[yeesian]

Okay yeah that works for me -- let's go with yeesian.com in that case to preserve the current behavior then, thanks for thinking it through!

[yeesian]

The docs are building now, so I'm closing this issue.

[visr]

This issue got sidetracked on whether the docs build at all, but the issue in the top post is not yet addressed, right?

[yeesian]

Oh sorry I missed it, thanks for the catch! Re-opening until we address the comments in https://github.com/yeesian/ArchGDAL.jl/issues/124#issue-629671325.

[rafaqz]

Sorry I missed this thread before, I probably should have added manual doces with that PR. See when I have time to do it.