Skip to content

Commit

Permalink
Add MultiDocumenter
Browse files Browse the repository at this point in the history
  • Loading branch information
adrhill committed Jan 16, 2024
1 parent 0df04d3 commit 0bf4ff4
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 180 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Generated files
*.jl.*.cov
*.jl.cov
*.jl.mem
/Manifest.toml
/docs/Manifest.toml
/docs/build/
/docs/out/

# VSCode
.vscode/
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Julia-XAI.github.io/XAIDocs.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Julia-XAI.github.io/XAIDocs.jl/dev/)
[![Build Status](https://github.com/Julia-XAI/XAIDocs.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Julia-XAI/XAIDocs.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/Julia-XAI/XAIDocs.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/Julia-XAI/XAIDocs.jl)
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
MultiDocumenter = "87ed4bf0-c935-4a67-83c3-2a03bee4197c"
XAIDocs = "02fa2cf1-3873-44c9-9e9f-421f1143b7d7"
43 changes: 43 additions & 0 deletions docs/make_multidocs.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import MultiDocumenter as MD

clonedir = mktempdir()

docs = [
MD.MultiDocRef(
upstream = joinpath(clonedir, "ExplainableAI"),
path = "explainableai",
name = "ExplainableAI",
giturl = "https://github.com/Julia-XAI/ExplainableAI.jl.git",
),
MD.MultiDocRef(
upstream = joinpath(clonedir, "RelevancePropagation"),
path = "RelevancePropagation",
name = "RelevancePropagation",
giturl = "https://github.com/Julia-XAI/RelevancePropagation.jl.git",
),
MD.DropdownNav("Heatmapping", [
MD.MultiDocRef(
upstream = joinpath(clonedir, "VisionHeatmaps"),
path = "visionheatmaps",
name = "VisionHeatmaps",
giturl = "https://github.com/Julia-XAI/VisionHeatmaps.jl.git",
),
MD.MultiDocRef(
upstream = joinpath(clonedir, "TextHeatmaps"),
path = "textheatmaps",
name = "TextHeatmaps",
giturl = "https://github.com/Julia-XAI/TextHeatmaps.jl.git",
),
]),
]

outpath = joinpath(@__DIR__, "out")

MD.make(
outpath,
docs;
search_engine = MD.SearchConfig(
index_versions = ["stable"],
engine = MD.FlexSearch
)
)
6 changes: 1 addition & 5 deletions src/XAIDocs.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
module XAIDocs

# Write your package code here.

end
module XAIDocs end
160 changes: 0 additions & 160 deletions test/Manifest.toml

This file was deleted.

3 changes: 0 additions & 3 deletions test/Project.toml

This file was deleted.

10 changes: 0 additions & 10 deletions test/runtests.jl

This file was deleted.

0 comments on commit 0bf4ff4

Please sign in to comment.