[Docs setup]

Author: divital-coder

docs/.gitignore

@@ -0,0 +1,2 @@
+node_modules/*
+package-lock.json

docs/Project.toml

@@ -0,0 +1,15 @@
+[deps]
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+EDM4hep = "eb32b910-dde9-4347-8fce-cd6be3498f0c"
+JetReconstruction = "44e8cb2c-dfab-4825-9c70-d4808a591196"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+
+[sources]
+JetReconstruction = {path = ".."}
+
+[compat]
+Documenter = "1.4"
+EDM4hep = "0.4"
+Makie = "0.20, 0.21"

docs/README.md

@@ -0,0 +1,51 @@
+# Generating and Previewing Documentation
+
+## Adding Documentation
+
+`Documenter.jl` is used to generate package documentation.
+
+The general guidelines are to have documentation split into meaningful sections,
+none of which are too long. If a new functionality is added then create a new
+documentation page in `src`. Then map that markdown file to a section in the
+documentation in `make.jl` in the `pages` map.
+
+## Previewing Documentation
+
+From the `docs` directory:
+
+```julia
+julia --project
+               _
+   _       _ _(_)_     |  Documentation: https://docs.julialang.org
+  (_)     | (_) (_)    |
+   _ _   _| |_  __ _   |  Type "?" for help, "]?" for Pkg help.
+  | | | | | | |/ _` |  |
+  | | |_| | | | (_| |  |  Version 1.11.1 (2024-10-16)
+ _/ |\__'_|_|_|\__'_|  |  Official https://julialang.org/ release
+|__/                   |
+
+julia> include("make.jl")
+[ Info: SetupBuildDirectory: setting up build directory.
+[ Info: Doctest: running doctests.
+[ Info: ExpandTemplates: expanding markdown templates.
+[ Info: CrossReferences: building cross-references.
+[ Info: CheckDocument: running document checks.
+[ Info: Populate: populating indices.
+[ Info: RenderDocument: rendering document.
+[ Info: HTMLWriter: rendering HTML pages.
+┌ Warning: Generated HTML over size_threshold_warn limit: lib/internal.md
+│     Generated file size: 128.16 (KiB)
+│     size_threshold_warn: 100.0 (KiB)
+│     size_threshold:      200.0 (KiB)
+│     HTML file:           lib/internal/index.html
+└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/C1XEF/src/html/HTMLWriter.jl:1828
+[ Info: Automatic `version="0.4.3"` for inventory from ../Project.toml
+┌ Warning: Documenter could not auto-detect the building environment. Skipping deployment.
+└ @ Documenter ~/.julia/packages/Documenter/C1XEF/src/deployconfig.jl:76
+
+julia> using LiveServer
+
+julia> LiveServer.serve(dir="build/")
+✓ LiveServer listening on http://localhost:8000/ ...
+  (use CTRL+C to shut down)
+```

docs/make.jl

@@ -0,0 +1,34 @@
+using Documenter
+using CairoMakie
+using EDM4hep
+using JetReconstruction
+
+push!(LOAD_PATH, "../ext/")
+
+include(joinpath(@__DIR__, "..", "ext", "JetVisualisation.jl"))
+include(joinpath(@__DIR__, "..", "ext", "EDM4hepJets.jl"))
+
+makedocs(sitename = "JetReconstruction.jl",
+         clean = false,
+         pages = [
+             "Home" => "index.md",
+             "Examples" => "examples.md",
+             "Particle Inputs" => "particles.md",
+             "Reconstruction Strategies" => "strategy.md",
+             "Substructure" => "substructure.md",
+             "Lund Jet Plane" => "lundplane.md",
+             "Jet Helpers" => "helpers.md",
+             "EDM4hep" => "EDM4hep.md",
+             "Recombination Schemes" => "recombination.md",
+             "SoftKiller" => "softkiller.md",
+             "Visualisation" => "visualisation.md",
+             "Contributing" => "contributing.md",
+             "Reference Docs" => Any["Public API" => "lib/public.md",
+                                     "Internal API" => "lib/internal.md"]
+         ])
+
+deploydocs(repo = "github.com/JuliaHEP/JetReconstruction.jl.git",
+           devbranch = "main",
+           devurl = "dev",
+           versions = ["stable" => "v^", "v#.#", "dev" => "dev"],
+           push_preview = true)

docs/src/EDM4hep.md

@@ -0,0 +1,45 @@
+# EDM4hep Inputs
+
+Extension functionality to read EDM4hep ReconstructedParticles, using the
+[EDM4hep.jl](https://github.com/peremato/EDM4hep.jl) package.
+
+## Examples
+
+EDM4hep `ReconstructedParticles` can be used as direct input into jet
+reconstruction.
+
+A number of working examples are maintained in the [EDM4hep examples
+directory](https://github.com/JuliaHEP/JetReconstruction.jl/tree/main/examples/EDM4hep)
+of the package's `examples`.
+
+Here is a snippet that shows the main steps:
+
+```julia
+using EDM4hep
+using EDM4hep.RootIO
+using JetReconstruction
+
+# Change this to something that works on your system
+input_file = joinpath("directory", "EDM4hep.root")
+reader = RootIO.Reader(input_file)
+events = RootIO.get(reader, "events")
+
+evt = events[1]
+
+recps = RootIO.get(reader, evt, "ReconstructedParticles")
+
+cs = jet_reconstruct(recps; algorithm = JetAlgorithm.Durham)
+```
+
+## Function Index
+
+```@index
+Pages = ["EDM4hep.md"]
+```
+
+## EDM4hep Interfaces
+
+```@autodocs
+Modules = [EDM4hepJets]
+Order = [:function]
+```