JuliaDocs / Documenter.jl

A documentation generator for Julia.

Home Page:https://documenter.juliadocs.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Got a `If you are seeing this warning/error after upgrading Documenter and this used to work`

TorkelE opened this issue · comments

This is my package: https://github.com/SciML/Catalyst.jl

I have recently tarted to try and update the documents (after quite a while). I am also moving to Documenter v1. In the build: https://github.com/SciML/Catalyst.jl/actions/runs/9198361101/job/25300923281?pr=861 I got a bunch of

┌ Error: Invalid type of object in @eval in src/home.md
│ ```@eval
│ using TOML
│ projtoml = joinpath("..", "..", "Project.toml")
│ version = TOML.parse(read(projtoml, String))["version"]
│ name = TOML.parse(read(projtoml, String))["name"]
│ link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * "/assets/Manifest.toml"
│ ```
│ Evaluated to `String`, but should be one of
│  - Nothing
│  - Markdown.MD
│ Falling back to textual code block representation.
│ 
│ If you are seeing this warning/error after upgrading Documenter and this used to work,
│ please open an issue on the Documenter issue tracker.
└ @ Documenter ~/.julia/packages/Documenter/CJeWX/src/utilities/utilities.jl:44
┌ Error: Invalid type of object in @eval in src/home.md
│ ```@eval
│ using TOML
│ projtoml = joinpath("..", "..", "Project.toml")
│ version = TOML.parse(read(projtoml, String))["version"]
│ name = TOML.parse(read(projtoml, String))["name"]
│ link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * "/assets/Project.toml"
│ ```
│ Evaluated to `String`, but should be one of
│  - Nothing
│  - Markdown.MD
│ Falling back to textual code block representation.
│ 
│ If you are seeing this warning/error after upgrading Documenter and this used to work,
│ please open an issue on the Documenter issue tracker.
└ @ Documenter ~/.julia/packages/Documenter/CJeWX/src/utilities/utilities.jl:44

This wasn't a problem before.

I have

Documenter = "1.4.1"

in my docs/Project.toml [compat] section.

I think these are the sections causing the problem:

## Reproducibility
```@raw html
<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
using Pkg # hide
Pkg.status() # hide
</details>
<details><summary>and using this machine and Julia version.</summary>
using InteractiveUtils # hide
versioninfo() # hide
</details>
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
using Pkg # hide
Pkg.status(; mode = PKGMODE_MANIFEST) # hide
</details>
You can also download the
<a href="
using TOML
projtoml = joinpath("..", "..", "Project.toml")
version = TOML.parse(read(projtoml, String))["version"]
name = TOML.parse(read(projtoml, String))["name"]
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * "/assets/Manifest.toml"
">manifest</a> file and the
<a href="
using TOML
projtoml = joinpath("..", "..", "Project.toml")
version = TOML.parse(read(projtoml, String))["version"]
name = TOML.parse(read(projtoml, String))["name"]
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * "/assets/Project.toml"
">project</a> file.