From 7b4a415ed230a06789e49a1d421662fc0cd3cf2d Mon Sep 17 00:00:00 2001 From: zymon Date: Wed, 27 Apr 2022 09:32:56 +0200 Subject: [PATCH] documentation webpage init A initialization of the webpage containing package documentation is build using `Documenter.jl`. --- docs/.gitignore | 2 ++ docs/Makefile | 7 +++++++ docs/Project.toml | 3 +++ docs/make.jl | 15 +++++++++++++++ docs/src/index.md | 8 ++++++++ 5 files changed, 35 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/Makefile create mode 100644 docs/Project.toml create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a303fff --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +build/ +site/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..88c7d90 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,7 @@ + + + + + +upload: + rsync -azvP ./build/ docs.zymon.org:/var/www/docs.zymon.org/STFT.jl/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..3c1805c --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,3 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +STFT = "58bb99bf-048b-48b7-93e7-1cbf3ee61509" diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..9bf254d --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,15 @@ +using Documenter +using STFT + +makedocs( + sitename = "STFT", + format = Documenter.HTML(), + modules = [STFT] +) + +# Documenter can also automatically deploy documentation to gh-pages. +# See "Hosting Documentation" and deploydocs() in the Documenter manual +# for more information. +#=deploydocs( + repo = "" +)=# diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..9886ea5 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,8 @@ +# STFT.jl + +Documentation for STFT.jl + +```@docs +STFT.analysis +STFT.synthesis +```