Skip to content

Commit

Permalink
Try to fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelBadr committed Sep 25, 2023
1 parent a0ff51f commit 1cbd376
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 29 deletions.
5 changes: 5 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
SparseIR = "4fe2279e-80f0-4adb-8463-ee114ff56b7d"

[compat]
Documenter = "1"
SparseIR = "1"
julia = "1.6"
56 changes: 27 additions & 29 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,31 @@ using Documenter

DocMeta.setdocmeta!(SparseIR, :DocTestSetup, :(using SparseIR))

makedocs(;
modules=[SparseIR],
authors="Samuel Badr <samuel.badr@gmail.com> and contributors",
repo="https://github.com/SpM-lab/SparseIR.jl/blob/{commit}{path}#{line}",
sitename="SparseIR.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
assets=String["assets/custom.css"],
mathengine=MathJax3(Dict(:loader => Dict("load" => [
"[tex]/physics"
]),
:tex => Dict("inlineMath" => [
["\$", "\$"],
["\\(", "\\)"]
],
"tags" => "ams",
"packages" => [
"base",
"ams",
"autoload",
"physics"
])))),
pages=["Home" => "index.md",
"Guide" => "guide.md",
"Public" => "public.md",
"Private" => "private.md"],
draft=get(ENV, "CI", "false") == "false")
makedocs(; modules=[SparseIR],
authors="Samuel Badr <samuel.badr@gmail.com> and contributors",
# repo="https://github.com/SpM-lab/SparseIR.jl/blob/{commit}{path}#{line}",
sitename="SparseIR.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
assets=String["assets/custom.css"],
mathengine=MathJax3(Dict(:loader => Dict("load" => [
"[tex]/physics"
]),
:tex => Dict("inlineMath" => [
["\$", "\$"],
["\\(", "\\)"]
],
"tags" => "ams",
"packages" => [
"base",
"ams",
"autoload",
"physics"
])))),
pages=["Home" => "index.md",
"Guide" => "guide.md",
"Public" => "public.md",
"Private" => "private.md"],
draft=get(ENV, "CI", "false") == "false")

deploydocs(;
repo="github.com/SpM-lab/SparseIR.jl.git")
deploydocs(; repo="github.com/SpM-lab/SparseIR.jl.git")

2 comments on commit 1cbd376

@SamuelBadr
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/92153

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.14 -m "<description of version>" 1cbd376144bdb3368dc1d7e444c927e68e254e9f
git push origin v1.0.14

Please sign in to comment.