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
10 changes: 9 additions & 1 deletion compendium/postchapters/document.tex
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,15 @@ \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}
Expand Down
1 change: 1 addition & 0 deletions contributors.tex
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
Erik Bjäreholt,
Erik Grampp,
Evelyn Beck,
Felix Ohrgren,
Fredrik Danebjer,
Fritjof Bengtsson,
Gustav Cedersjö,
Expand Down