From fbe6b473010f3a5b779a95115ef7e2aa86aaa61b Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Thu, 19 Sep 2024 17:12:06 +0900 Subject: [PATCH] mkdocs: Add mkdocs Signed-off-by: Arisu Tachibana --- .github/workflows/docs_publish.yml | 18 ++++++++++++++++ docs/index.md | 3 +++ mkdocs.yml | 34 ++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+) create mode 100644 .github/workflows/docs_publish.yml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs_publish.yml b/.github/workflows/docs_publish.yml new file mode 100644 index 0000000..1238830 --- /dev/null +++ b/.github/workflows/docs_publish.yml @@ -0,0 +1,18 @@ +--- +name: Docs publish + +on: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.7 + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..3c9484b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# kci-dev + +kci-dev is a cmdline tool for interact with a enabled KernelCI server diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..9d534a3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,34 @@ +--- +# Project Information +site_name: kci-dev +site_author: Arisu Tachibana +site_description: >- + kci-dev is a cmdline tool for interact with a + enabled KernelCI server. + +# Repository information +repo_name: kernelci/kci-dev +repo_url: https://github.com/kernelci/kci-dev +edit_uri: "" + +# Configuration +theme: + name: material + icon: + repo: fontawesome/brands/github + features: + - navigation.instant + - navigation.tabs + language: en + +# Footer +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/kernelci + name: kernelci on GitHub + +# Page tree +nav: + - Home: + - Introduction: index.md