From da720c7dc0d4e33adc6412ec45007f4f954a26c4 Mon Sep 17 00:00:00 2001 From: Felix Ohrgren <179166750+fgren@users.noreply.github.com> Date: Sun, 15 Dec 2024 14:34:39 +0100 Subject: [PATCH 1/3] add: information about scaladoc links --- compendium/postchapters/document.tex | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/compendium/postchapters/document.tex b/compendium/postchapters/document.tex index 1001ae67..836f265b 100644 --- a/compendium/postchapters/document.tex +++ b/compendium/postchapters/document.tex @@ -171,7 +171,14 @@ \subsection{Generera dokumentation} Du genererar dokumentation enklast med hjälp av körverktyget \code{scala-cli}. I terminalen skriv \\\code{scala-cli doc . -o api} -När \code{scala-cli} är färdig med att generera dokumentationen så meddelas vilken katalog som dokumentationen ligger i. Du läser dokumentationen genom att öppna filen \texttt{index.html} i en webbläsare. +När \code{scala-cli} är färdig med att generera dokumentationen så meddelas vilken katalog som dokumentationen ligger i. För att länkarna inom dokumentationen ska fungera krävs antingen att du kör en lokal webbserver i katalogen eller att du använder ett program för att konvertera länkarna till lokala sådana. + +\subsubsection{Använda en lokal webbserver} +Om du har Python 3 installerat på din dator har du en inkluderad webbserver. Du startar denna i terminalen med \\\code{python -m http.server} när du står i dokumentationens katalog. För att öppna dokumentationen besöker du sedan \url{http://localhost:8000} i din webbläsare. + +\subsubsection{Använda ett program för att konvertera länkar} +Om du inte har Python installerat kan du köra ett Scala-program som byter ut alla länkar till lokala sådana, vilket gör att de går att öppna direkt. Detta kan laddas ner från \\ +\url{https://github.com/dixine55/Scaladoc-Local-Version-Patcher/blob/main/scaladocPatch.scala}. Placera programmet i dokumentationsmappen och kör det med \\\code{scala-cli run .} när du är i dokumentationens mapp. Du öppnar sedan dokumentationen genom filen \\\texttt{index.html} i din webbläsare. Mer att läsa om att generera dokumentation finns här: \\ \url{https://scala-cli.virtuslab.org/docs/commands/doc} From 3714c5d360cb3fc1e9ba6c9ed97e6af4f4e04d8c Mon Sep 17 00:00:00 2001 From: Felix Ohrgren <179166750+fgren@users.noreply.github.com> Date: Sun, 15 Dec 2024 15:07:23 +0100 Subject: [PATCH 2/3] Change formatting --- compendium/postchapters/document.tex | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/compendium/postchapters/document.tex b/compendium/postchapters/document.tex index 836f265b..4afc1222 100644 --- a/compendium/postchapters/document.tex +++ b/compendium/postchapters/document.tex @@ -174,11 +174,12 @@ \subsection{Generera dokumentation} När \code{scala-cli} är färdig med att generera dokumentationen så meddelas vilken katalog som dokumentationen ligger i. För att länkarna inom dokumentationen ska fungera krävs antingen att du kör en lokal webbserver i katalogen eller att du använder ett program för att konvertera länkarna till lokala sådana. \subsubsection{Använda en lokal webbserver} -Om du har Python 3 installerat på din dator har du en inkluderad webbserver. Du startar denna i terminalen med \\\code{python -m http.server} när du står i dokumentationens katalog. För att öppna dokumentationen besöker du sedan \url{http://localhost:8000} i din webbläsare. +Om du har Python 3 installerat på din dator har du en inkluderad webbserver. Du startar denna i terminalen med \code{python -m http.server} när du står i dokumentationens katalog. För att öppna dokumentationen besöker du sedan \url{http://localhost:8000} i din webbläsare. \subsubsection{Använda ett program för att konvertera länkar} Om du inte har Python installerat kan du köra ett Scala-program som byter ut alla länkar till lokala sådana, vilket gör att de går att öppna direkt. Detta kan laddas ner från \\ -\url{https://github.com/dixine55/Scaladoc-Local-Version-Patcher/blob/main/scaladocPatch.scala}. Placera programmet i dokumentationsmappen och kör det med \\\code{scala-cli run .} när du är i dokumentationens mapp. Du öppnar sedan dokumentationen genom filen \\\texttt{index.html} i din webbläsare. +\url{https://github.com/dixine55/Scaladoc-Local-Version-Patcher/blob/main/scaladocPatch.scala}. \\ +Placera programmet i dokumentationsmappen och kör det med \code{scala-cli run .} när du är i dokumentationens mapp. Du öppnar sedan dokumentationen genom filen \texttt{index.html} i din webbläsare. \\ Mer att läsa om att generera dokumentation finns här: \\ \url{https://scala-cli.virtuslab.org/docs/commands/doc} From ecadfc5844ac3333479988f6ac7edeb8f4de01de Mon Sep 17 00:00:00 2001 From: Felix Ohrgren <179166750+fgren@users.noreply.github.com> Date: Sun, 15 Dec 2024 15:34:54 +0100 Subject: [PATCH 3/3] add to contributors --- contributors.tex | 1 + 1 file changed, 1 insertion(+) diff --git a/contributors.tex b/contributors.tex index a896ec38..d252571f 100644 --- a/contributors.tex +++ b/contributors.tex @@ -26,6 +26,7 @@ Erik Bjäreholt, Erik Grampp, Evelyn Beck, +Felix Ohrgren, Fredrik Danebjer, Fritjof Bengtsson, Gustav Cedersjö,