documentation webpage init

A initialization of the webpage containing package documentation is build using
`Documenter.jl`.
This commit is contained in:
zymon 2022-04-27 09:32:56 +02:00
parent 9aafb6770f
commit 7b4a415ed2
5 changed files with 35 additions and 0 deletions

2
docs/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
build/
site/

7
docs/Makefile Normal file
View file

@ -0,0 +1,7 @@
upload:
rsync -azvP ./build/ docs.zymon.org:/var/www/docs.zymon.org/STFT.jl/

3
docs/Project.toml Normal file
View file

@ -0,0 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
STFT = "58bb99bf-048b-48b7-93e7-1cbf3ee61509"

15
docs/make.jl Normal file
View file

@ -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 = "<repository url>"
)=#

8
docs/src/index.md Normal file
View file

@ -0,0 +1,8 @@
# STFT.jl
Documentation for STFT.jl
```@docs
STFT.analysis
STFT.synthesis
```