Support Documentation

Author: terasakisatoshi

.gitignore

@@ -1 +1,2 @@
 Manifest.toml
+docs/build

README.md

@@ -1,5 +1,7 @@
 # [TerminalSystemMonitor.jl](https://github.com/AtelierArith/TerminalSystemMonitor.jl)
 
+[![Build Status](https://github.com/AtelierArith/TerminalSystemMonitor.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AtelierArith/TerminalSystemMonitor.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://AtelierArith.github.io/TerminalSystemMonitor.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://AtelierArith.github.io/TerminalSystemMonitor.jl/dev/)
+
 ## Description
 
 This Julia package displays CPU and RAM usage information on your computer. If necessary, one can show GPU usage.

docs/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+TerminalSystemMonitor = "bd0a793d-05ca-4aa9-be12-7c4786d45f63"

docs/make.jl

@@ -0,0 +1,23 @@
+using TerminalSystemMonitor
+using Documenter
+
+DocMeta.setdocmeta!(TerminalSystemMonitor, :DocTestSetup, :(using TerminalSystemMonitor); recursive=true)
+
+makedocs(;
+    modules=[TerminalSystemMonitor],
+    authors="Satoshi Terasaki <[email protected]> and contributors",
+    sitename="TerminalSystemMonitor.jl",
+    format=Documenter.HTML(;
+        canonical="https://atelierarith.github.io/TerminalSystemMonitor.jl",
+        edit_link="main",
+        assets=String[],
+    ),
+    pages=[
+        "Home" => "index.md",
+    ],
+)
+
+deploydocs(;
+    repo="github.com/AtelierArith/TerminalSystemMonitor.jl",
+    devbranch="main",
+)

docs/src/index.md

@@ -0,0 +1,14 @@
+```@meta
+CurrentModule = TerminalSystemMonitor
+```
+
+# TerminalSystemMonitor
+
+Documentation for [TerminalSystemMonitor](https://github.com/terasakisatoshi/TerminalSystemMonitor.jl).
+
+```@index
+```
+
+```@autodocs
+Modules = [TerminalSystemMonitor]
+```

src/TerminalSystemMonitor.jl

@@ -6,12 +6,12 @@ import Term # this is required by UnicodePlots.panel
 using MLDataDevices: MLDataDevices, CUDADevice
 
 # Define dummy method to avoid getting errors on testing using JET.jl
-function plot_gpu_utilization_rates(::Type{CUDADevice}, dummyargs=nothing)::Vector{Any} 
+function plot_gpu_utilization_rates(::Type{CUDADevice}, dummyargs=nothing)::Vector{Any}
     Any[]
 end
 
 # Define dummy method to avoid getting errors on testing using JET.jl
-function plot_gpu_memory_utilization(::Type{CUDADevice}, dummyargs=nothing)::Vector{Any} 
+function plot_gpu_memory_utilization(::Type{CUDADevice}, dummyargs=nothing)::Vector{Any}
     Any[]
 end
 
@@ -25,7 +25,9 @@ busy_time(info::Sys.CPUinfo) = Int64(
     get_cpu_percent(period)
 
 CPU usage between 0.0 and 100 [percent]
+
 The idea is borrowed from https://discourse.julialang.org/t/get-cpu-usage/24468/7
+
 Thank you @fonsp.
 """
 function get_cpu_percent(period::Real = 1.0)