diff --git a/.github/workflows/document.yml b/.github/workflows/document.yml index 528f12f..18b6598 100644 --- a/.github/workflows/document.yml +++ b/.github/workflows/document.yml @@ -20,4 +20,4 @@ jobs: - name: Build and deploy env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token - run: julia --color=yes --project=docs/ docs/makeLocal.jl + run: julia --color=yes --project=docs/ docs/make.jl diff --git a/docs/make.jl b/docs/make.jl index 5b7bb3f..86a3287 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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 @@ -37,7 +31,7 @@ makedocs(; pages=[ "Home" =>[ "index.md", - "Installation.md", + "Installation.md", "SmallExample.md", ], diff --git a/docs/makeLocal.jl b/docs/makeLocal.jl deleted file mode 100644 index 9d0c2fb..0000000 --- a/docs/makeLocal.jl +++ /dev/null @@ -1,17 +0,0 @@ -# Modify the LOAD_PATH to include the source directory -push!(LOAD_PATH, joinpath(@__DIR__, "..", "src")) - -# Import Pkg module -using Pkg - -# Activate the project in the 'docs' folder -Pkg.activate(joinpath(@__DIR__, "..", "docs")) - -# Update the project environment -Pkg.instantiate() - -# Import required packages -using GromovWitten, Documenter - -# Run doctests for GromovWitten -doctest(GromovWitten)