registered, update docs; fix CI doc build

mahiki · Aug 26, 2023 · 2e31129 · 2e31129
1 parent 3b048e2
commit 2e31129
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 18 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -57,17 +57,18 @@ jobs:
           version: '1'
       - name: Configure doc environment
         run: |
-          julia --project=docs/ -e '
+          julia --project=docs -e '
             using Pkg
             Pkg.develop(PackageSpec(path=pwd()))
             Pkg.instantiate()'
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-docdeploy@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - run: |
-          julia --project=docs -e '
-            using Documenter: DocMeta, doctest
-            using PrefectInterfaces
-            DocMeta.setdocmeta!(PrefectInterfaces, :DocTestSetup, :(using PrefectInterfaces); recursive=true)
-            doctest(PrefectInterfaces)'
+            julia --project=docs -e '
+                using Documenter: DocMeta, doctest
+                using PrefectInterfaces
+                DocMeta.setdocmeta!(PrefectInterfaces, :DocTestSetup, :(using PrefectInterfaces); recursive=true)
+                doctest(PrefectInterfaces)'
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/README.md b/README.md
@@ -7,12 +7,11 @@ This is a small package that helps you connect to a Prefect instance from a Juli
 
 ## Installation
 ```julia
-# Package registration pending
-julia> Pkg.add("https://github.com/mahiki/PrefectInterfaces.jl")
+julia> Pkg.add("PrefectInterfaces")
 ```
 
 ## Usage
-* A Prefect server/cloud instance must be available via API URL to use these functions, the examples below are hypothetical.
+* A Prefect server/cloud instance must be available via API URL to use these functions, the examples below are hypothetical and require a running Prefect server with blocks registered in the names below.
 * See [Prefect local installation instructions.](docs/src/prefect/install-local-prefect-environment.md)
 
 ```julia

diff --git a/docs/docs/Project.toml b/docs/docs/Project.toml
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,5 @@
-using PrefectInterfaces
 using Documenter
+using PrefectInterfaces
 
 DocMeta.setdocmeta!(PrefectInterfaces, :DocTestSetup, :(using PrefectInterfaces); recursive=true)
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -14,10 +14,6 @@ Included in the package is a bootstrapped installation of a local Prefect instan
     See [Prefect Installation](@ref) to quickly launch a local Prefect server.
 
 ```julia
-# Package registration is pending
-julia> Pkg.add("https://github.com/mahiki/PrefectInterfaces.jl")
-
-# After 2023-08-24
 julia> Pkg.add("PrefectInterfaces")
 ```
 ## Usage