From 2384ae0819d4358fc18af6effd636e4e702d0258 Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Sat, 2 Sep 2023 09:10:35 +1000 Subject: [PATCH] Improve docs tooling --- Taskfile.yaml | 5 ++++ mkdocs-website/README.md | 41 +++++++++++++++++++++++++++++++++ mkdocs-website/Taskfile.yml | 29 +++++++++++++++++++++++ mkdocs-website/requirements.txt | 35 ++++++++++++++++++++++++++++ v3/Taskfile.yaml | 7 ++++++ v3/cmd/wails3/main.go | 4 ---- v3/go.mod | 12 +++++----- v3/go.sum | 6 +++++ 8 files changed, 129 insertions(+), 10 deletions(-) create mode 100644 mkdocs-website/README.md create mode 100644 mkdocs-website/Taskfile.yml create mode 100644 mkdocs-website/requirements.txt diff --git a/Taskfile.yaml b/Taskfile.yaml index 7cc165825..03e6e2208 100644 --- a/Taskfile.yaml +++ b/Taskfile.yaml @@ -16,6 +16,11 @@ includes: dir: v3 optional: true + docs: + taskfile: mkdocs-website + dir: mkdocs-website + optional: true + tasks: contributors:check: cmds: diff --git a/mkdocs-website/README.md b/mkdocs-website/README.md new file mode 100644 index 000000000..f5c42bb10 --- /dev/null +++ b/mkdocs-website/README.md @@ -0,0 +1,41 @@ +# v3 Docs + +This is the documentation for Wails v3. It is currently a work in progress. + +## Recommended Setup Steps + +Install the wails3 CLI if you haven't already: + +```shell +go install github.com/wailsapp/wails/v2/cmd/wails3@latest +``` + +The documentation uses mkdocs, so you will need to install [Python](https://www.python.org/). Once installed, +you can setup the documentation by running the following command: + +```bash +wails3 task docs:setup +``` + +This will install the required dependencies for you. + +If you have installed the wails3 CLI, you can run the following command to build the documentation and serve it locally: + +```bash +wails3 task docs:serve +``` + +### Manual Setup + +To install manually, you will need to do the following: + + - Install [Python](https://www.python.org/) + - Run `pip install -r requirements.txt` to install the required dependencies + - Run `mkdocs serve` to serve the documentation locally + - Run `mkdocs build` to build the documentation + + +## Contributing + +If you would like to contribute to the documentation, please feel free to open a PR! + diff --git a/mkdocs-website/Taskfile.yml b/mkdocs-website/Taskfile.yml new file mode 100644 index 000000000..a94af273c --- /dev/null +++ b/mkdocs-website/Taskfile.yml @@ -0,0 +1,29 @@ +# https://taskfile.dev + +version: '3' + +tasks: + + setup: + summary: Setup the project + preconditions: + - sh: python{{exeExt}} --version + msg: "Looks like Python isn't installed. Python is required to build the documentation: https://www.python.org/downloads/" + cmds: + - python -m pip install -r requirements.txt --user + + build: + summary: Builds the documentation + preconditions: + - sh: mkdocs --version + msg: "Looks like mkdocs isn't installed. Run `wails3 task setup` or `task setup` in the documentation directory to install it." + cmds: + - mkdocs build + + serve: + summary: Builds the documentation and serves it locally + preconditions: + - sh: mkdocs --version + msg: "Looks like mkdocs isn't installed. Run `wails3 task setup` or `task setup` in the documentation directory to install it." + cmds: + - mkdocs serve diff --git a/mkdocs-website/requirements.txt b/mkdocs-website/requirements.txt new file mode 100644 index 000000000..bfed5e978 --- /dev/null +++ b/mkdocs-website/requirements.txt @@ -0,0 +1,35 @@ +Babel==2.12.1 +beautifulsoup4==4.12.2 +certifi==2023.7.22 +charset-normalizer==3.2.0 +click==8.1.7 +colorama==0.4.6 +cssselect==1.2.0 +ghp-import==2.1.0 +idna==3.4 +Jinja2==3.1.2 +lxml==4.9.3 +Markdown==3.4.4 +markdown2==2.4.10 +MarkupSafe==2.1.3 +mergedeep==1.3.4 +mkdocs==1.5.2 +mkdocs-material==9.2.6 +mkdocs-material-extensions==1.1.1 +packaging==23.1 +paginate==0.5.6 +pathspec==0.11.2 +platformdirs==3.10.0 +Pygments==2.16.1 +pymdown-extensions==10.2.1 +pyquery==2.0.0 +python-dateutil==2.8.2 +PyYAML==6.0.1 +pyyaml_env_tag==0.1 +readtime==3.0.0 +regex==2023.8.8 +requests==2.31.0 +six==1.16.0 +soupsieve==2.4.1 +urllib3==2.0.4 +watchdog==3.0.0 diff --git a/v3/Taskfile.yaml b/v3/Taskfile.yaml index 9f959ebf1..47dfdd631 100644 --- a/v3/Taskfile.yaml +++ b/v3/Taskfile.yaml @@ -12,6 +12,11 @@ includes: dir: ./website optional: true + docs: + taskfile: ../mkdocs-website + dir: ../mkdocs-website + optional: true + tasks: recreate-template-dir: dir: internal/templates @@ -119,3 +124,5 @@ tasks: format: cmds: - task: format:md + + diff --git a/v3/cmd/wails3/main.go b/v3/cmd/wails3/main.go index f3e90965c..95038b616 100644 --- a/v3/cmd/wails3/main.go +++ b/v3/cmd/wails3/main.go @@ -3,7 +3,6 @@ package main import ( "github.com/pterm/pterm" "github.com/samber/lo" - "github.com/wailsapp/wails/v3/cmd/wails3/ui" "os" "runtime/debug" @@ -29,9 +28,6 @@ func main() { app := clir.NewCli("wails", "The Wails CLI", "v3") app.NewSubCommandFunction("build", "Build the project", commands.Build) app.NewSubCommandFunction("init", "Initialise a new project", commands.Init) - app.NewSubCommand("contribute", "Contribute to Wails development").Action(func() error { - return ui.Run() - }) task := app.NewSubCommand("task", "Run and list tasks") var taskFlags commands.RunTaskOptions task.AddFlags(&taskFlags) diff --git a/v3/go.mod b/v3/go.mod index 5530e2cd6..ed2e80db1 100644 --- a/v3/go.mod +++ b/v3/go.mod @@ -26,12 +26,12 @@ require ( github.com/pkg/browser v0.0.0-20210706143420-7d21f8c997e2 github.com/pkg/errors v0.9.1 github.com/pterm/pterm v0.12.51 - github.com/samber/lo v1.37.0 + github.com/samber/lo v1.38.1 github.com/tc-hib/winres v0.1.6 - github.com/wailsapp/go-webview2 v1.0.5 + github.com/wailsapp/go-webview2 v1.0.6-0.20230901120557-e959fdf1ccc3 github.com/wailsapp/mimetype v1.4.1 github.com/wailsapp/wails/v3/cmd/wails3/ui v0.0.0-20210706143420-7d21f8c997e2 - golang.org/x/net v0.7.0 + golang.org/x/net v0.10.0 golang.org/x/sys v0.11.0 modernc.org/sqlite v1.21.0 ) @@ -69,7 +69,7 @@ require ( github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 // indirect github.com/radovskyb/watcher v1.0.7 // indirect github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect - github.com/rivo/uniseg v0.2.0 // indirect + github.com/rivo/uniseg v0.4.4 // indirect github.com/sajari/fuzzy v1.0.0 // indirect github.com/sergi/go-diff v1.2.0 // indirect github.com/xanzy/ssh-agent v0.3.0 // indirect @@ -81,8 +81,8 @@ require ( golang.org/x/oauth2 v0.0.0-20200902213428-5d25da1a8d43 // indirect golang.org/x/sync v0.3.0 // indirect golang.org/x/term v0.11.0 // indirect - golang.org/x/text v0.7.0 // indirect - golang.org/x/tools v0.2.0 // indirect + golang.org/x/text v0.9.0 // indirect + golang.org/x/tools v0.6.0 // indirect google.golang.org/appengine v1.6.6 // indirect google.golang.org/protobuf v1.25.0 // indirect gopkg.in/warnings.v0 v0.1.2 // indirect diff --git a/v3/go.sum b/v3/go.sum index 581596fb6..296fd4c96 100644 --- a/v3/go.sum +++ b/v3/go.sum @@ -301,6 +301,7 @@ github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94 github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo= github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/rogpeppe/go-internal v1.10.1-0.20230524175051-ec119421bb97 h1:3RPlVWzZ/PDqmVuf/FKHARG5EMid/tl7cv54Sw/QRVY= github.com/rogpeppe/go-internal v1.10.1-0.20230524175051-ec119421bb97/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= @@ -308,6 +309,7 @@ github.com/sajari/fuzzy v1.0.0 h1:+FmwVvJErsd0d0hAPlj4CxqxUtQY/fOoY0DwX4ykpRY= github.com/sajari/fuzzy v1.0.0/go.mod h1:OjYR6KxoWOe9+dOlXeiCJd4dIbED4Oo8wpS89o0pwOo= github.com/samber/lo v1.37.0 h1:XjVcB8g6tgUp8rsPsJ2CvhClfImrpL04YpQHXeHPhRw= github.com/samber/lo v1.37.0/go.mod h1:9vaz2O4o8oOnK23pd2TrXufcbdbJIa3b6cstBWKpopA= +github.com/samber/lo v1.38.1/go.mod h1:+m/ZKRl6ClXCE2Lgf3MsQlWfh4bn1bz6CXEOxnEXnEA= github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= @@ -335,6 +337,7 @@ github.com/tmclane/purego v0.0.0-20230601213035-1f25e70d7b01 h1:oQwu3iNDywGp1Hry github.com/tmclane/purego v0.0.0-20230601213035-1f25e70d7b01/go.mod h1:ah1In8AOtksoNK6yk5z1HTJeUkC1Ez4Wk2idgGslMwQ= github.com/wailsapp/go-webview2 v1.0.5 h1:VtPABYX2Zwpi0BxGy0vpZ9mTOGDHxCDLZa0gvgJWhhI= github.com/wailsapp/go-webview2 v1.0.5/go.mod h1:Uk2BePfCRzttBBjFrBmqKGJd41P6QIHeV9kTgIeOZNo= +github.com/wailsapp/go-webview2 v1.0.6-0.20230901120557-e959fdf1ccc3/go.mod h1:Uk2BePfCRzttBBjFrBmqKGJd41P6QIHeV9kTgIeOZNo= github.com/wailsapp/mimetype v1.4.1 h1:pQN9ycO7uo4vsUUuPeHEYoUkLVkaRntMnHJxVwYhwHs= github.com/wailsapp/mimetype v1.4.1/go.mod h1:9aV5k31bBOv5z6u+QP8TltzvNGJPmNJD4XlAL3U+j3o= github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI= @@ -436,6 +439,7 @@ golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qx golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.7.0 h1:rJrUqqhjsgNp7KqAIc25s9pZnjU7TUcSY7HcVZjdn1g= golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -514,6 +518,7 @@ golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo= golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= @@ -562,6 +567,7 @@ golang.org/x/tools v0.0.0-20200929161345-d7fc70abf50f/go.mod h1:z6u4i615ZeAfBE4X golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.2.0 h1:G6AHpWxTMGY1KyEYoAQ5WTtIekUUvDNjan3ugu60JvE= golang.org/x/tools v0.2.0/go.mod h1:y4OqIKeOV/fWJetJ8bXPU1sEVniLMIyDAZWeHdV+NTA= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=