From 97b8c9d4ec01023d0d0a306a1a4e8580c0eb2de4 Mon Sep 17 00:00:00 2001 From: Nathanael Wong Date: Tue, 24 Sep 2024 16:34:40 -0400 Subject: [PATCH] More updates to documentation --- docs/make.jl | 4 ++-- docs/src/api/addreadremove.md | 19 +++++++++++++++++++ docs/src/api/project.md | 8 ++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 docs/src/api/addreadremove.md create mode 100644 docs/src/api/project.md diff --git a/docs/make.jl b/docs/make.jl index 1bb46c16..1a043131 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,7 +20,7 @@ makedocs(; pages=[ "Home" => "index.md", "What is a GeoRegion?" => "georegions.md", - "Basic Functionality" => [ + "Basics" => [ "Retrieving GeoRegions" => [ "Overview (START HERE)" => "basics/read/overview.md", "Predefined GeoRegions" => "basics/read/predefined.md", @@ -33,7 +33,7 @@ makedocs(; "Is it in a GeoRegion?" => "basics/properties/isin.md", ] ], - "GeoRegions.jl Tutorials" => [ + "Tutorials" => [ "Project Setup (START HERE)" => "tutorials/projects.md", "Custom GeoRegion Files" => "tutorials/files.md", ], diff --git a/docs/src/api/addreadremove.md b/docs/src/api/addreadremove.md new file mode 100644 index 00000000..18c11805 --- /dev/null +++ b/docs/src/api/addreadremove.md @@ -0,0 +1,19 @@ +# API for Adding, Reading and Removing GeoRegions + +```@docs +GeoRegion( + geoID :: AbstractString; + path :: AbstractString = homedir() + ) -> geo :: GeoRegion +``` + +```@docs +add +rm +``` + +You can also remove a GeoRegion associated with an `ID`. + +```@docs +rmID +``` \ No newline at end of file diff --git a/docs/src/api/project.md b/docs/src/api/project.md new file mode 100644 index 00000000..1fd72db0 --- /dev/null +++ b/docs/src/api/project.md @@ -0,0 +1,8 @@ +# API for Project-Handling in GeoRegions.jl + + +```@docs +setupGeoRegions +tableGeoRegions +deleteGeoRegions +``` \ No newline at end of file