Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

try documenter 1.0 upgrade #371

Merged
merged 3 commits into from
Sep 23, 2023
Merged

try documenter 1.0 upgrade #371

merged 3 commits into from
Sep 23, 2023

Conversation

ArnoStrouwen
Copy link
Member

No description provided.

@ArnoStrouwen ArnoStrouwen marked this pull request as draft September 16, 2023 18:03
@codecov
Copy link

codecov bot commented Sep 16, 2023

Codecov Report

Merging #371 (daf7212) into main (5a25b7d) will increase coverage by 14.17%.
The diff coverage is 5.00%.

@@             Coverage Diff             @@
##             main     #371       +/-   ##
===========================================
+ Coverage   20.01%   34.19%   +14.17%     
===========================================
  Files          14       23        +9     
  Lines        1444     1787      +343     
===========================================
+ Hits          289      611      +322     
- Misses       1155     1176       +21     
Files Changed Coverage Δ
ext/LinearSolveBlockDiagonalsExt.jl 0.00% <0.00%> (ø)
ext/LinearSolveKernelAbstractionsExt.jl 0.00% <0.00%> (ø)
ext/LinearSolveMKLExt.jl 0.00% <0.00%> (ø)
ext/LinearSolveMetalExt.jl 0.00% <ø> (ø)
src/appleaccelerate.jl 0.00% <0.00%> (ø)
src/extension_algs.jl 66.66% <ø> (+66.66%) ⬆️
src/LinearSolve.jl 93.84% <100.00%> (+6.15%) ⬆️

... and 12 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ArnoStrouwen
Copy link
Member Author

@mortenpi Could you have a look at the failure here:
https://github.com/SciML/LinearSolve.jl/actions/runs/6208844246/job/16855431354?pr=371#step:5:11

@mortenpi
Copy link

So I don't think that's causing the error, but you will run into trouble with these at-eval blocks, which are returning a String. That's no longer allowed.

```@raw html
You can also download the
<a href="
```
```@eval
using TOML
version = TOML.parse(read("../../Project.toml", String))["version"]
name = TOML.parse(read("../../Project.toml", String))["name"]
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
"/assets/Manifest.toml"
```
```@raw html
">manifest</a> file and the
<a href="
```
```@eval
using TOML
version = TOML.parse(read("../../Project.toml", String))["version"]
name = TOML.parse(read("../../Project.toml", String))["name"]
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
"/assets/Project.toml"
```
```@raw html
">project</a> file.
```

Instead, this should be done with an object that has an text/html show method.

@mortenpi
Copy link

mortenpi commented Sep 18, 2023

Alright, the main error is a Documenter regression. It actually comes from the (perfectly fine) use of the @doc_str macro here: https://github.com/SciML/SciMLBase.jl/blob/8d293bfc0b859b1ae870772aaf023d2a93f6eb45/src/problems/basic_problems.jl#L1

@ArnoStrouwen ArnoStrouwen marked this pull request as ready for review September 23, 2023 00:34
@ChrisRackauckas ChrisRackauckas merged commit 6593133 into SciML:main Sep 23, 2023
12 of 17 checks passed
@ArnoStrouwen ArnoStrouwen deleted the doc1.0 branch September 23, 2023 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants