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.

Sign up for GitHub

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

MassInstallAction: Install the Documenter workflow on this repository #22

Merged
merged 2 commits into from
Dec 13, 2020
Merged

MassInstallAction: Install the Documenter workflow on this repository #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4a8211
Switch to GitHub action to build docs
timholy Dec 12, 2020
66e72e9
Update docs for qualified MethodInstances
timholy Dec 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/Documenter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Documenter
on:
push:
branches: [master]
tags: [v*]
pull_request:

jobs:
Documenter:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: julia-actions/setup-julia@v1
with:
version: nightly
show-versioninfo: true
- uses: actions/checkout@v2
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*.jl.mem
.DS_Store
/Manifest.toml
/docs/Manifest.toml
/dev/
/docs/build/
/docs/site/
2 changes: 2 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
MethodAnalysis = "85b6ec6f-f7df-4429-9514-a64bcd9ee824"

[compat]
Documenter = "0.25"
4 changes: 4 additions & 0 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
using Documenter, MethodAnalysis

using InteractiveUtils
display(versioninfo())

makedocs(;
modules=[MethodAnalysis],
format=Documenter.HTML(),
Expand All @@ -13,4 +16,5 @@ makedocs(;

deploydocs(;
repo="github.com/timholy/MethodAnalysis.jl",
push_preview=true,
)
48 changes: 24 additions & 24 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,12 @@ Let's see all the compiled instances of `Base.setdiff` and their immediate calle
```jldoctest; setup=(using MethodAnalysis)
julia> direct_backedges(setdiff)
6-element Vector{Any}:
MethodInstance for setdiff(::Base.KeySet{Any, Dict{Any, Any}}, ::Base.KeySet{Any, Dict{Any, Any}}) => MethodInstance for keymap_merge(::Dict{Char, Any}, ::Dict{Any, Any})
MethodInstance for setdiff(::Base.KeySet{Any, Dict{Any, Any}}, ::Base.KeySet{Any, Dict{Any, Any}}) => MethodInstance for keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Base.KeySet{Char, Dict{Char, Any}}, ::Base.KeySet{Any, Dict{Any, Any}}) => MethodInstance for keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Base.KeySet{Any, Dict{Any, Any}}, ::Base.KeySet{Char, Dict{Char, Any}}) => MethodInstance for keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Base.KeySet{Char, Dict{Char, Any}}, ::Base.KeySet{Char, Dict{Char, Any}}) => MethodInstance for keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Vector{Base.UUID}, ::Vector{Base.UUID}) => MethodInstance for deps_graph(::Pkg.Types.Context, ::Dict{Base.UUID, String}, ::Dict{Base.UUID, Pkg.Types.VersionSpec}, ::Dict{Base.UUID, Pkg.Resolve.Fixed})
MethodInstance for setdiff(::Base.KeySet{Any, Dict{Any, Any}}, ::Base.KeySet{Any, Dict{Any, Any}}) => MethodInstance for REPL.LineEdit.keymap_merge(::Dict{Char, Any}, ::Dict{Any, Any})
MethodInstance for setdiff(::Base.KeySet{Any, Dict{Any, Any}}, ::Base.KeySet{Any, Dict{Any, Any}}) => MethodInstance for REPL.LineEdit.keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Base.KeySet{Char, Dict{Char, Any}}, ::Base.KeySet{Any, Dict{Any, Any}}) => MethodInstance for REPL.LineEdit.keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Base.KeySet{Any, Dict{Any, Any}}, ::Base.KeySet{Char, Dict{Char, Any}}) => MethodInstance for REPL.LineEdit.keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Base.KeySet{Char, Dict{Char, Any}}, ::Base.KeySet{Char, Dict{Char, Any}}) => MethodInstance for REPL.LineEdit.keymap_merge(::Dict{Char, Any}, ::Union{Dict{Any, Any}, Dict{Char, Any}})
MethodInstance for setdiff(::Vector{Base.UUID}, ::Vector{Base.UUID}) => MethodInstance for Pkg.Operations.deps_graph(::Pkg.Types.Context, ::Dict{Base.UUID, String}, ::Dict{Base.UUID, Pkg.Types.VersionSpec}, ::Dict{Base.UUID, Pkg.Resolve.Fixed})
```

### Printing backedges as a tree
Expand All @@ -116,36 +116,36 @@ MethodInstance for findfirst(::BitVector)

julia> MethodAnalysis.print_tree(mi)
MethodInstance for findfirst(::BitVector)
├─ MethodInstance for prune_graph!(::Graph)
│ └─ MethodInstance for var"#simplify_graph!#111"(::Bool, ::typeof(simplify_graph!), ::Graph, ::Set{Int64})
│ └─ MethodInstance for simplify_graph!(::Graph, ::Set{Int64})
│ └─ MethodInstance for simplify_graph!(::Graph)
│ ├─ MethodInstance for trigger_failure!(::Graph, ::Vector{Int64}, ::Tuple{Int64, Int64})
├─ MethodInstance for Pkg.Resolve.prune_graph!(::Graph)
│ └─ MethodInstance for Pkg.Resolve.var"#simplify_graph!#111"(::Bool, ::typeof(simplify_graph!), ::Graph, ::Set{Int64})
│ └─ MethodInstance for Pkg.Resolve.simplify_graph!(::Graph, ::Set{Int64})
│ └─ MethodInstance for Pkg.Resolve.simplify_graph!(::Graph)
│ ├─ MethodInstance for Pkg.Resolve.trigger_failure!(::Graph, ::Vector{Int64}, ::Tuple{Int64, Int64})
│ │ ⋮
│ │
│ └─ MethodInstance for resolve_versions!(::Context, ::Vector{PackageSpec})
│ └─ MethodInstance for Pkg.Operations.resolve_versions!(::Context, ::Vector{PackageSpec})
│ ⋮
│
└─ MethodInstance for update_solution!(::SolutionTrace, ::Graph)
└─ MethodInstance for converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
├─ MethodInstance for converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
│ ├─ MethodInstance for converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
│ │ ├─ MethodInstance for converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
└─ MethodInstance for Pkg.Resolve.update_solution!(::SolutionTrace, ::Graph)
└─ MethodInstance for Pkg.Resolve.converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
├─ MethodInstance for Pkg.Resolve.converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
│ ├─ MethodInstance for Pkg.Resolve.converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
│ │ ├─ MethodInstance for Pkg.Resolve.converge!(::Graph, ::Messages, ::SolutionTrace, ::NodePerm, ::MaxSumParams)
│ │ │ ⋮
│ │ │
│ │ └─ MethodInstance for maxsum(::Graph)
│ │ └─ MethodInstance for Pkg.Resolve.maxsum(::Graph)
│ │ ⋮
│ │
│ └─ MethodInstance for maxsum(::Graph)
│ └─ MethodInstance for resolve(::Graph)
│ └─ MethodInstance for Pkg.Resolve.maxsum(::Graph)
│ └─ MethodInstance for Pkg.Resolve.resolve(::Graph)
│ ⋮
│
└─ MethodInstance for maxsum(::Graph)
└─ MethodInstance for resolve(::Graph)
├─ MethodInstance for trigger_failure!(::Graph, ::Vector{Int64}, ::Tuple{Int64, Int64})
└─ MethodInstance for Pkg.Resolve.maxsum(::Graph)
└─ MethodInstance for Pkg.Resolve.resolve(::Graph)
├─ MethodInstance for Pkg.Resolve.trigger_failure!(::Graph, ::Vector{Int64}, ::Tuple{Int64, Int64})
│ ⋮
│
└─ MethodInstance for resolve_versions!(::Context, ::Vector{PackageSpec})
└─ MethodInstance for Pkg.Operations.resolve_versions!(::Context, ::Vector{PackageSpec})
⋮
```

Expand Down