From 1ea12cc179799f764493446d5178610148196cc0 Mon Sep 17 00:00:00 2001 From: Sheeba Samuel Date: Fri, 12 Apr 2024 01:05:08 +0200 Subject: [PATCH] Add the documentation files with mkdocs. --- .github/workflows/ci.yml | 29 +++++++++++++++++++++++++++++ docs/content/index.md | 2 ++ docs/mkdocs.yml | 4 ++++ 3 files changed, 35 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 docs/content/index.md create mode 100644 docs/mkdocs.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..3ff578e --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,29 @@ +name: ci +on: + push: + branches: + - master + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/content/index.md b/docs/content/index.md new file mode 100644 index 0000000..56b591b --- /dev/null +++ b/docs/content/index.md @@ -0,0 +1,2 @@ +# FAIR Jupyter + diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..ced8253 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: FAIR Jupyter +docs_dir: content +theme: + name: material