From faafe4a511972f8f7276e89b267d0e2bd3a4be21 Mon Sep 17 00:00:00 2001
From: Tamas Gal <himself@tamasgal.com>
Date: Wed, 30 Oct 2024 09:13:20 +0100
Subject: [PATCH] Update docs
---
docs/make.jl | 3 ---
docs/src/api.md | 2 +-
docs/src/examples/an_example.md | 17 -----------------
docs/src/index.md | 33 ++++++++++++++++++++++++++-------
4 files changed, 27 insertions(+), 28 deletions(-)
delete mode 100644 docs/src/examples/an_example.md
diff --git a/docs/make.jl b/docs/make.jl
index 35ad0d2..6d9c281 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -13,9 +13,6 @@ makedocs(;
warnonly = [:missing_docs],
pages = [
"Home" => "index.md",
- "Examples" => Any[
- "examples/an_example.md",
- ],
"API" => "api.md"
],
repo = Documenter.Remotes.URL(
diff --git a/docs/src/api.md b/docs/src/api.md
index 8aec936..01dbe66 100644
--- a/docs/src/api.md
+++ b/docs/src/api.md
@@ -5,5 +5,5 @@
```
```@docs
-meaningoflife
+filepath
```
diff --git a/docs/src/examples/an_example.md b/docs/src/examples/an_example.md
deleted file mode 100644
index 8804da7..0000000
--- a/docs/src/examples/an_example.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# An example
-
-The following function determines the meaning of life.
-
-```@example usage
-using KM3Aux
-
-meaningoflife()
-```
-
-Examples with the same "tag" (like `usage` above) share the same Julia
-process, so that everything is in the same scope. The package is therefore already
-imported, so we can determine the meaning of life again `;)`
-
-```@example usage
-meaningoflife()
-```
diff --git a/docs/src/index.md b/docs/src/index.md
index dbe07c8..a1ca503 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -1,29 +1,48 @@
-# KM3Aux.jl
+# KM3Aux
-This is the documentation of the awesome `KM3Aux.jl` Julia package.
+[](https://common.pages.km3net.de/KM3Aux.jl/stable)
+[](https://common.pages.km3net.de/KM3Aux.jl/dev)
+[](https://git.km3net.de/common/KM3Aux.jl/pipelines)
+[](https://git.km3net.de/common/KM3Aux.jl/commits/main)
-!!! note
+Welcome to the `KM3Aux.jl` repository! Your partner for accessing files from the
+legendary [KM3NeT Auxiliary Files Archive](https://git.km3net.de/auxiliary_data/calibration)
+for calibration data.
+
+
+## Documentation
+
+Check out the **[Latest Documention](https://common.pages.km3net.de/KM3Aux.jl/dev)**
+which also includes tutorials and examples.
- This package is still under development!
## Installation
-`KM3Aux.jl` is **not an officially registered Julia package** but it's available on
-the **[KM3NeT Julia registry](https://git.km3net.de/common/julia-registry)**. To add
+`KM3Aux.jl` is not an officially registered Julia package but it's available via
+the [KM3NeT Julia registry](https://git.km3net.de/common/julia-registry). To add
the KM3NeT Julia registry to your local Julia registry list, follow the
instructions in its
[README](https://git.km3net.de/common/julia-registry#adding-the-registry) or simply do
git clone https://git.km3net.de/common/julia-registry ~/.julia/registries/KM3NeT
-After that, you can instal `KM3Aux.jl` just like any other Julia package:
+After that, you can add `KM3Aux.jl` just like any other Julia package:
julia> import Pkg; Pkg.add("KM3Aux")
+
## Quickstart
+Make sure to clone the [KM3NeT Auxiliary Files Archive](https://git.km3net.de/auxiliary_data/calibration)
+to a folder and set the environment variable `KM3AUX_CALIB_PATH` to that path:
+
+ git clone git@git.km3net.de:auxiliary_data/calibration.git /path/to/the/archive
+ export KM3AUX_CALIB_PATH=/path/to/the/archive
``` julia-repl
julia> using KM3Aux
+julia> fpath = filepath(160, 19468, "pmt")
+"/path/to/the/archive/00000160/pmt/_H_1.1.3/00019465/00019532/1.txt"
```
+
--
GitLab