diff --git a/Project.toml b/Project.toml index 84cb36b..e74d616 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "CitableBase" uuid = "d6f014bd-995c-41bd-9893-703339864534" authors = ["Neel Smith "] -version = "1.2.0" +version = "1.2.1" [deps] DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" diff --git a/docs/make.jl b/docs/make.jl index f3ef704..13e3fc5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -11,7 +11,8 @@ using Documenter, DocStringExtensions, CitableBase makedocs( sitename = "CitableBase.jl", pages = [ - "Home" => "index.md" + "Home" => "index.md", + "API documentation" => "apis.md" ] ) diff --git a/docs/src/apis.md b/docs/src/apis.md new file mode 100644 index 0000000..af226ab --- /dev/null +++ b/docs/src/apis.md @@ -0,0 +1,23 @@ + +```@meta +CurrentModule = CitableBase +``` + +## Types +```@docs +Urn +Citable +``` + +## Functions +```@docs +validurn +components +parts +``` + +## Functions to implement for specific URN types +```@docs +addversion +dropversion +``` \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index 98ef192..a0ae47e 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,23 +1,8 @@ -# CitableBase.jl Documentation -```@meta -CurrentModule = CitableBase -``` +# CitableBase.jl -## Types -```@docs -Urn -Citable -``` +CitableBase.jl defines two core abstractions of the CITE architecture: + +1. identifiers expressible using the syntax of the IETF URN specification +2. citable units, identified by URN, and including a human-readable label -## Functions -```@docs -validurn -components -parts -``` -## Functions to implement for specific URN types -```@docs -addversion -dropversion -``` \ No newline at end of file