diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 13135a7..3baf4d8 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -29,10 +29,14 @@ jobs: julia_version: "1.7" - documenter_version: "0.27" julia_version: "1.8" - - documenter_version: "1.1" + - documenter_version: "1.0" julia_version: "1.9" - - documenter_version: "1.2" + - documenter_version: "1.1" julia_version: "1.10" + - documenter_version: "1.2" + julia_version: "1" + - documenter_version: "master" + julia_version: "1" steps: - uses: actions/checkout@v4 - uses: julia-actions/setup-julia@v1 @@ -46,9 +50,13 @@ jobs: run: | import Pkg Pkg.develop(path=".") - Pkg.pin([ - Pkg.PackageSpec(name="Documenter", version=ENV["DOCUMENTER_VERSION"]), - ]) + if ENV["DOCUMENTER_VERSION"] == "master" + Pkg.develop(url="https://github.com/JuliaDocs/Documenter.jl") + else + Pkg.pin([ + Pkg.PackageSpec(name="Documenter", version=ENV["DOCUMENTER_VERSION"]), + ]) + end Pkg.instantiate() Pkg.resolve() Pkg.status() diff --git a/Project.toml b/Project.toml index 93a7865..13af79c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "DocumenterInventoryWritingBackport" uuid = "195adf08-069f-4855-af3e-8933a2cdae94" authors = ["Michael Goerz and contributors"] -version = "0.1.0" +version = "0.1.0+dev" [deps] CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193" diff --git a/README.md b/README.md index 19fda1e..e83c0ec 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![Build Status](https://github.com/JuliaDocs/DocumenterInventoryWritingBackport.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaDocs/DocumenterInventoryWritingBackport.jl/actions/workflows/CI.yml?query=branch%3Amaster) -[`DocumenterInventoryWritingBackport.jl`](https://github.com/JuliaDocs/DocumenterInventoryWritingBackport.jl) is a backport the `Documenter v1.3` [feature of generating an `objects.inv` inventory file](https://github.com/JuliaDocs/Documenter.jl/pull/2424) to `Documenter v0.25`–`v1.2`. +[`DocumenterInventoryWritingBackport.jl`](https://github.com/JuliaDocs/DocumenterInventoryWritingBackport.jl) is a backport of the [inventory-writing feature](https://github.com/JuliaDocs/Documenter.jl/pull/2424) in `Documenter v1.3` to `Documenter v0.25`–`v1.2`. -See [Inventor Generation](http://juliadocs.org/DocumenterInterLinks.jl/stable/write_inventory/) for details. +See ["Inventory Generation"](http://juliadocs.org/DocumenterInterLinks.jl/stable/write_inventory/) in the `DocumenterInterLinks` documentation for details. ## Installation @@ -20,7 +20,7 @@ in the Julia REPL, or by adding DocumenterInventoryWritingBackport = "195adf08-069f-4855-af3e-8933a2cdae94" ``` -to the relevant `Project.toml` file. +to the relevant `Project.toml` file (e.g., `docs/Project.toml`). ## Usage @@ -31,6 +31,6 @@ Add using DocumenterInventoryWritingBackport ``` -to a project's `docs/make.jl` file, or in the REPL where you are building the project's documentation. Then, build the documentation as normal. +to a project's `docs/make.jl` file, [or in the REPL where you are building the project's documentation](https://juliadocs.org/DocumenterInterLinks.jl/dev/howtos/#howto-manual-inventory). Then, build the documentation as normal. Simply loading `DocumenterInventoryWritingBackport` in this way should be sufficient to ensure that an `objects.inv` inventory file will be created when building the documentation.