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

Fix broken doctest #71

Closed
wants to merge 3 commits into from
Closed

Fix broken doctest #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
07878ff
Fix broken doctest
fingolfin Mar 6, 2024
a6c4f50
Fix docs/make.jl *again*
fingolfin Mar 6, 2024
6c9e7f5
Add comment explaining how to use docs/make.jl
fingolfin Mar 6, 2024
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
20 changes: 7 additions & 13 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
#=
To build the documentation, do this from within the GromovWitten.jl directory:

# Modify the LOAD_PATH to include the source directory
#push!(LOAD_PATH, joinpath(@__DIR__, "..", "src"))
# Activate the project in the parent directory
Pkg.activate(joinpath(@__DIR__, "..", "docs")) # Activate the 'docs' project
julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
julia --project=docs/ docs/make.jl

# Import Pkg module
using Pkg

# Activate the project in the parent directory
Pkg.activate(joinpath(@__DIR__, ".."))

# Install Documenter package
Pkg.add("Documenter")
To run the tests again, it suffices to repeat the second command.
=#

# Import required packages
using GromovWitten
Expand All @@ -37,7 +31,7 @@ makedocs(;
pages=[
"Home" =>[
"index.md",
"Installation.md",
"Installation.md",
"SmallExample.md",
],

Expand Down
78 changes: 0 additions & 78 deletions docs/makeLocal.jl
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/src/SmallExample.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ FeynmanIntegral(FeynmanGraph([(1, 2), (1, 2), (1, 2)]), Dict{Symbol, Dict{Vector

We compute then the Feynman Integral of degree 3.

```jldoctest graph
```jldoctest mygraph
julia> f = feynman_integral_degree(F, 3)
24*q[1]^6 + 20*q[1]^4*q[2]^2 + 20*q[1]^4*q[3]^2 + 20*q[1]^2*q[2]^4 + 20*q[1]^2*q[3]^4 + 24*q[2]^6 + 20*q[2]^4*q[3]^2 + 20*q[2]^2*q[3]^4 + 24*q[3]^6
```
Loading