Skip to content

Commit

Permalink
start Documenter 1.0 upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnoStrouwen committed Sep 25, 2023
1 parent cebef6d commit ec07d34
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 13 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@ on:
pull_request:
branches:
- master
paths-ignore:
- 'docs/**'
push:
branches:
- master
paths-ignore:
- 'docs/**'
jobs:
test:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"

[compat]
BenchmarkTools = "1.3"
Documenter = "0.27"
Documenter = "1"
Latexify = "0.15, 0.16"
OrdinaryDiffEq = "6.31"
Plots = "1.36"
Expand Down
15 changes: 3 additions & 12 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,10 @@ makedocs(
sitename="Symbolics.jl",
authors="Chris Rackauckas",
modules=[Symbolics,SymbolicUtils],
clean=true,doctest=false,
strict=[
:doctest,
:linkcheck,
:parse_error,
:example_block,
# Other available options are
# :autodocs_block, :cross_references, :docs_block, :eval_block, :example_block, :footnote, :meta_block, :missing_docs, :setup_block
],
format = Documenter.HTML(#analytics = "UA-90474609-3",
assets = ["assets/favicon.ico"]),
clean=true, doctest=false, linkcheck = true,
format = Documenter.HTML(assets = ["assets/favicon.ico"],
mathengine = mathengine,
#canonical="https://mtk.sciml.ai/stable/"),
canonical="https://docs.sciml.ai/Symbolics/stable/"),
pages=[
"Home" => "index.md",
"getting_started.md",
Expand Down
58 changes: 58 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,61 @@ to be listed here, feel free to open a pull request!
- [ReversePropagation.jl](https://github.com/dpsanders/ReversePropagation.jl): Source-to-source reverse mode automatic differentiation
- Automated tracing of code and construction of backpropagation equations
- Composes with symbolic transformation and simplification functionality

## Reproducibility

```@raw html
<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
```

```@example
using Pkg # hide
Pkg.status() # hide
```

```@raw html
</details>
```

```@raw html
<details><summary>and using this machine and Julia version.</summary>
```

```@example
using InteractiveUtils # hide
versioninfo() # hide
```

```@raw html
</details>
```

```@raw html
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
```

```@example
using Pkg # hide
Pkg.status(; mode = PKGMODE_MANIFEST) # hide
```

```@raw html
</details>
```

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

0 comments on commit ec07d34

Please sign in to comment.