fix doc build (#295)

* using GOCore

* Fix errors found in docs

* Set the current module in the Literate source

This way, docstrings are resolved respective to where the page is.

* add TGGeometry to docs project

* Update docs/src/api.md

Author: asinghvi17

GeometryOpsCore/src/types/manifold.jl

@@ -16,7 +16,7 @@ In GeometryOps (and geodesy more generally), there are three manifolds we care a
 - [`AutoManifold`](@ref): a special manifold that automatically selects the best manifold for the operation when it's executed.  Resolves to [`Planar`](@ref), [`Spherical`](@ref), or [`Geodesic`](@ref) depending on the input geometry.
 
 Generally, we aim to have `Linear` and `Spherical` be operable everywhere, whereas `Geodesic` will only apply in specific circumstances.
-Currently, those circumstances are [`area`](@ref), [`arclength`](@ref), and [`segmentize`](@ref), but this could be extended with time and https://github.com/JuliaGeo/SphericalGeodesics.jl.
+Currently, those circumstances are [`area`](@ref), `arclength`, and [`segmentize`](@ref), but this could be extended with time and https://github.com/JuliaGeo/SphericalGeodesics.jl.
 =#
 
 export Manifold, AutoManifold, Planar, Spherical, Geodesic

GeometryOpsCore/src/types/operation.jl

@@ -37,6 +37,14 @@ Here intersection_alg can be Foster, which we already have in GeometryOps, or GE
 but if we ever implement e.g. RelateNG in GeometryOps, we can add that in.
 =#
 
+"""
+    abstract type Operation{Alg <: Algorithm} end
+
+Operations are callable structs, that contain the entire specification for what the algorithm will do.
+
+Sometimes they may be underspecified and only materialized fully when you see the geometry, so you can extract
+the best manifold for those geometries.
+"""
 abstract type Operation{Alg <: Algorithm} end
 
 #= 

docs/Project.toml

@@ -42,6 +42,7 @@ Proj = "c94c279d-25a6-4763-9509-64d165bea63e"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Shapefile = "8e980c4a-a4fe-5da2-b3a7-4b4b0353a2f4"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+TGGeometry = "d7e755d2-3c95-4bcf-9b3c-79ab1a78647b"
 
 [sources]
 GeometryOps = {path = "../"}

docs/make.jl

@@ -1,9 +1,12 @@
-using GeometryOps
+using GeometryOps, GeometryOpsCore
 using Documenter, DocumenterVitepress
 using Literate
 using Makie, CairoMakie
 CairoMakie.activate!(px_per_unit = 2, type = "svg", inline = true) # TODO: make this svg
 
+# import packages that activate extensions
+import FlexiJoins, LibGEOS, Proj, TGGeometry
+
 DocMeta.setdocmeta!(GeometryOps, :DocTestSetup, :(using GeometryOps; using GeometryOps.GeometryBasics); recursive=true)
 
 using GeoInterfaceMakie
@@ -41,9 +44,29 @@ function _add_meta_edit_link_generator(path)
     end
 end
 
+function _add_meta_current_module(current_module::String)
+    return function (input)
+        return """
+        ```@meta
+        CurrentModule = $(current_module)
+        ```
+        """ * input
+    end
+end
+
 # First letter of `str` is made uppercase and returned
 ucfirst(str::String) = string(uppercase(str[1]), str[2:end])
 
+function current_module_from_paths(source_path, relative_path)
+    if contains(source_path, "GeometryOpsCore")
+        return "GeometryOpsCore"
+    elseif endswith(source_path, "src")
+        return "GeometryOps"
+    elseif endswith(source_path, "ext")
+        return "Base.get_extension(GeometryOps, :$(splitpath(relative_path)[1]))"
+    end
+end
+
 function process_literate_recursive!(pages::Vector{Any}, path::String)
     global source_path
     global output_path
@@ -55,10 +78,11 @@ function process_literate_recursive!(pages::Vector{Any}, path::String)
         if endswith(path, ".jl")
             relative_path = relpath(path, source_path)
             output_dir = joinpath(output_path, splitdir(relative_path)[1])
+            
             Literate.markdown(
                 path, output_dir; 
                 flavor = Literate.CommonMarkFlavor(), 
-                postprocess = _add_meta_edit_link_generator(joinpath(relpath(source_path, output_dir), relative_path))
+                postprocess = _add_meta_edit_link_generator(joinpath(relpath(source_path, output_dir), relative_path)) ∘ _add_meta_current_module(current_module_from_paths(source_path, relative_path))
             )
             push!(pages, joinpath("source", splitext(relative_path)[1] * ".md"))
         end
@@ -67,6 +91,7 @@ end
 
 withenv("JULIA_DEBUG" => "Literate") do # allow Literate debug output to escape to the terminal!
     global literate_pages
+    empty!(literate_pages)
     vec = []
     process_literate_recursive!(vec, source_path)
     literate_pages = vec[1][2] # this is a hack to get the pages in the correct order, without an initial "src" folder.  
@@ -90,7 +115,7 @@ download("https://hackmd.io/kpIqAR8YRJOZQDJjUKVAUQ/download", joinpath(@__DIR__,
 
 # Finally, make the docs!
 makedocs(;
-    modules=[GeometryOps, GeometryOps.GeometryOpsCore],
+    modules=[GeometryOps, GeometryOpsCore],
     authors="Anshul Singhvi <[email protected]> and contributors",
     repo="https://github.com/JuliaGeo/GeometryOps.jl/blob/{commit}{path}#{line}",
     sitename="GeometryOps.jl",
@@ -118,6 +143,7 @@ makedocs(;
         "Source code" => literate_pages,
     ],
     warnonly = true,
+    draft = true,
 )
 
 deploydocs(;

docs/src/api.md

@@ -56,11 +56,13 @@ barycentric_interpolate
 ```
 
 ## Other methods
+
 ```@autodocs
 Modules = [GeometryOps]
 ```
 
 ## Core types
+
 ```@autodocs
 Modules = [GeometryOpsCore]
 ```

src/types.jl

@@ -158,7 +158,7 @@ to use the appropriate PROJ function via `Proj.jl` for the operation.
 ## Extended help
 
 This is the default algorithm for [`reproject`](@ref), and will also be the default algorithm for 
-operations on geodesics like [`area`](@ref) and [`arclength`](@ref).
+operations on geodesics like [`area`](@ref) and `arclength`.
 """
 struct PROJ{M <: Manifold} <: Algorithm{M}
     manifold::M
@@ -183,3 +183,5 @@ function enforce(alg::PROJ, kw::Symbol, f)
         error("$(f) requires a `$(kw)` keyword argument to the `GEOS` algorithm, which was not provided.")
     end
 end
+
+