diff --git a/.taskcluster.yml b/.taskcluster.yml index 37cb4a98f..5f7883c74 100644 --- a/.taskcluster.yml +++ b/.taskcluster.yml @@ -44,3 +44,30 @@ tasks: description: Run tests for taskchampion owner: dustin@v.igoro.us source: ${repo_url} + - $if: run + then: + provisionerId: 'proj-misc' + workerType: 'ci' + deadline: {$fromNow: '1 hour'} + expires: {$fromNow: '1 day'} + payload: + maxRunTime: 3600 + image: rust:latest + command: + - /bin/bash + - '-c' + - >- + git clone ${repo_url} repo && + cd repo && + git config advice.detachedHead false && + git checkout ${ref} && + cd docs && + curl -L --compressed https://github.com/rust-lang/mdBook/releases/download/v0.4.4/mdbook-v0.4.4-x86_64-unknown-linux-gnu.tar.gz | gunzip -c | tar -xf - && + chmod +x mdbook && + ./mdbook test && + ./mdbook build + metadata: + name: taskchampion-book + description: Verify that the docs build with mdbook + owner: dustin@v.igoro.us + source: ${repo_url} diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..7585238ef --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..7aaa35c16 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +This is an [mdbook](https://rust-lang.github.io/mdBook/index.html) book. +Minor modifications can be made without installing the mdbook tool, as the content is simple Markdown. +Changes are verified on pull requests. diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 000000000..0e19be438 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Dustin J. Mitchell"] +language = "en" +multilingual = false +src = "src" +title = "TaskChampion" diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 000000000..e499e5c62 --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Development Notes](./development-notes.md) diff --git a/docs/development-notes.md b/docs/src/development-notes.md similarity index 100% rename from docs/development-notes.md rename to docs/src/development-notes.md