Skip to content

Commit

Permalink
Test again dev-version of Documenter
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Feb 27, 2024
1 parent 9f2d845 commit f705284
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
18 changes: 13 additions & 5 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "DocumenterInventoryWritingBackport"
uuid = "195adf08-069f-4855-af3e-8933a2cdae94"
authors = ["Michael Goerz <[email protected]> and contributors"]
version = "0.1.0"
version = "0.1.0+dev"

[deps]
CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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.

0 comments on commit f705284

Please sign in to comment.