add skeleton docs

add skeleton docs

add forgotten file

Author: ablaom

README.md

@@ -18,7 +18,7 @@ packages providing a machine learning toolbox. The MLJModelRegistry.jl has two f
 
 - It provides software tools for MLJ maintainers to manage the Model Registry, for example
   to add the models provided by a new machine learning package providing an MLJ model
-  interface.
+  interface for those models.
 
 This repository does not provide any MLJ user code but does contain metadata downloaded as
 a Julia `Artifact` by MLJ software. See the

docs/Project.toml

@@ -0,0 +1,8 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
+MLJModelRegistry = "0a96183e-380b-4aa6-be10-c555140810f2"
+
+[compat]
+Documenter = "1"
+julia = "1.10"

docs/make.jl

@@ -0,0 +1,27 @@
+using Documenter
+using MLJModelRegistry
+using DocumenterInterLinks
+using MLJModelRegistry.GenericRegistry
+
+const  REPO = Remotes.GitHub("JuliaAI", "MLJModelRegistry.jl")
+
+makedocs(
+    modules=[MLJModelRegistry, GenericRegistry],
+    format=Documenter.HTML(
+        prettyurls = true,
+        collapselevel = 1,
+    ),
+    pages=[
+        "Home" => "index.md",
+        "Internals" => "internals.md",
+    ],
+    sitename="MLJModelRegistry.jl",
+    warnonly = [:cross_references, :missing_docs],
+    repo = Remotes.GitHub("JuliaAI", "MLJModelRegistry.jl"),
+)
+
+deploydocs(
+    devbranch="dev",
+    push_preview=false,
+    repo="github.com/JuliaAI/MLJModelRegistry.jl.git",
+)

docs/src/index.md

@@ -0,0 +1,42 @@
+# MLJModelInterface.jl
+
+Home of the MLJ Model Registry
+
+# What's this repository for?
+
+[MLJ](https://juliaml.ai) (Machine Learning in Julia) is a suite of Julia software
+packages providing a machine learning toolbox. The MLJModelRegistry.jl has two functions: 
+
+- It hosts the *MLJ Model Registry*, a list of packages providing MLJ interfaces to
+  machine learning algorithms, together with metadata about those models, such as the type
+  of data models can operate on.
+  
+- It provides software tools for MLJ maintainers to manage the Model Registry, for example
+  to add the models provided by a new machine learning package providing an MLJ model
+  interface for those models.
+  
+The model registry itself consists of files in [this
+folder](https://github.com/JuliaAI/MLJModelRegisry.jl/master/registry/), ordinarily
+accessed in one of two ways:
+
+- By MLJ users, through the package
+  [MLJModels.jl](https://github.com/JuliaAI/MLJModels.jl) which downloads the registry
+  files as a Julia `Artifact`.
+
+- By developers wishing to update the registry, but using software tools provided by the
+  MLJModelRegistry.jl package, as described in this documentation.
+  
+As it is for MLJ developers, none of the code provided in this repository is part of the
+standard MLJ distribution.
+
+## Contents
+
+- [Registering a new model](@ref)
+
+- [Updating metadata for existing models](@ref)
+
+- [Complete list of registry maintenance tools](@ref)
+
+- [Internals](@ref)
+
+

docs/src/internals.md

@@ -0,0 +1,9 @@
+# Internals 
+
+This page contains privates method documentation for maintainers of the
+MLJModelRegistry.jl software tools.
+
+```@autodocs
+Modules = [MLJModelRegistry, GenericRegistry]
+```
+

src/GenericRegistry.jl

@@ -4,26 +4,27 @@
 
 Module providing basic tools to manage a *package registry*, by which is meant a package
 environment, together with "package metata", in the form of a dictionary of TOML-parsable
-values, keyed on the environment's package dependencies, which is stored in TOML file.
-This file is called Metadata.toml and lives in the environment file containing the
-environment Project.toml file. Not to be confused with a package registry in the sense of
-the standard library, `Pkg`.
+values, keyed on the environment's package dependencies, which is stored in a TOML file in
+the same directory as the Project.toml file for the environment.  This file is called
+Metadata.toml and lives in the environment file containing the environment Project.toml
+file. Not to be confused with a package registry in the sense of the standard library,
+`Pkg`.
 
 # Methods
 
-- [`GenericRegistry.dependencies(environment)`](@ref): Get a list of the environment's
+- `GenericRegistry.dependencies(environment)`: Get a list of the environment's
   dependencies (vector of package name strings).
 
 - [`GenericRegistry.run`](@ref): In a new Julia process, load a package (or packages) from
- the package environment and execute a Julia expression there; results are returnedn as
- `Future` objects to allow asynchronous `run` calls. Useful for generating metadata about
- a package.
+  the package environment and execute a Julia expression there; results are returned as
+  `Future` objects, to allow asynchronous `run` calls. Useful for generating metadata about
+  a package.
 
-- [`GenericRegistry.close(future)`](@ref): Shut down the process intitiated by the `run`
+- `GenericRegistry.close(future)`: Shut down the process intitiated by the `run`
   call that returned `future` (after calling `fetch(future)` to get the result of
   evaluation).
 
-- [`GenericRegisry.put`](@ref): Insert an item in the metadata dictionary
+- [`GenericRegistry.put`](@ref): Insert an item in the metadata dictionary
 
 - [`GenericRegistry.get`](@ref): Inspect the metadata
 
@@ -43,7 +44,7 @@ Pkg.status()
 #  [bd369af6] Tables v1.12.1
 
 Pkg.activate(temp=true)
-Pkg.add("MLJModels")
+Pkg.add("MLJModelRegistry")
 using MLJModels.GenericRegistry
 packages = GenericRegistry.dependencies(env)
 # 2-element Vector{String}:
@@ -117,7 +118,7 @@ end
 # # METHODS
 
 """
-    run(ex, pkgs[, environment])
+    GenericRegistry.run(ex, pkgs[, environment])
 
 In a temporary Julia process, evaluate the expression `ex` after importing the specified
 packages, `pkgs`, using an instantiated version of the specified package `environment`,
@@ -160,7 +161,7 @@ end
 close(future) = rmprocs(future.where)
 
 """
-    put(pkg, value, environment)
+    GenericRegistry.put(pkg, value, environment)
 
 In the metata dictionary associated with specified package environment, assign `value` to
 the key `pkg`.
@@ -178,7 +179,7 @@ function put(pkg, value, env)
 end
 
 """
-    get(pkg, environment)
+    GenericRegistry.get(pkg, environment)
 
 Return the metadata associated with package, `pkg`, if it is a dependency of `environment`
 and if `pkg` is a key in associated metadata dictionary. Otherwise, return `nothing`.
@@ -193,7 +194,7 @@ function get(pkg, env)
 end
 
 """
-    gc(environment)
+    GenericRegistry.gc(environment)
 
 Remove key-value pairs from the metadata dictionary associated with the specified
 `environment` in all cases in which the key is not a package dependency. An optional