Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
DOCUMENTER_LATEX_DEBUG: ${{ github.workspace }}/latex-debug-logs
run: julia --color=yes --project=docs/ docs/make.jl
run: julia --color=yes --project=docs -p 2 docs/make.jl
- uses: actions/upload-artifact@v6
if: ${{ always() }}
with:
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
build/
latex_build/
latex_src/
src/tutorials/*/*.md
!src/tutorials/*/introduction.md
!src/tutorials/algorithms/parallelism.md
Expand Down
7 changes: 1 addition & 6 deletions docs/DocumenterReference.jl
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import MarkdownAST

struct _Config
current_module::Module
root::String
subdirectory::String
modules::Dict{Module,<:Vector}
sort_by::Function
Expand All @@ -35,7 +34,6 @@ Documenter.Selectors.order(::Type{APIBuilder}) = 0.0

"""
automatic_reference_documentation(;
root::String,
subdirectory::String,
modules::Dict{Module,Vector{Pair{String,DocType}}},
sort_by::Function = identity,
Expand All @@ -60,7 +58,6 @@ Each time you call this function, a new object is added to the global variable
`DocumenterReference.CONFIG`.
"""
function automatic_reference_documentation(;
root::String,
subdirectory::String,
modules::Vector,
sort_by::Function = identity,
Expand All @@ -73,7 +70,6 @@ function automatic_reference_documentation(;
current_module = first(_to_extras(m))
pages = _automatic_reference_documentation(
current_module;
root,
subdirectory,
modules = _modules,
sort_by,
Expand All @@ -85,12 +81,11 @@ end

function _automatic_reference_documentation(
current_module::Module;
root::String,
subdirectory::String,
modules::Dict{Module,<:Vector},
sort_by::Function,
)
push!(CONFIG, _Config(current_module, root, subdirectory, modules, sort_by))
push!(CONFIG, _Config(current_module, subdirectory, modules, sort_by))
return "$subdirectory/$current_module.md"
end

Expand Down
Loading