diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml new file mode 100644 index 0000000..f01f789 --- /dev/null +++ b/.github/workflows/build_docs.yml @@ -0,0 +1,35 @@ +on: + push: + branches: + - 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 + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install setuptools + bash install.sh + python -m pip install -r docs/requirements.txt + + - 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 diff --git a/README.md b/README.md index 06313ba..41afa5b 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@
+ ## About * **What is the ConFIG method?** @@ -99,9 +100,9 @@ for input_i in dataset: optimizer.step() ``` -More details and examples can be found in our [doc page]("https://qiauil.github.io/ConFIG/"). +More details and examples can be found in our [doc page](https://qiauil.github.io/ConFIG/). -To reproduce the result in our paper, please check the [experiments](https://github.com/tum-pbs/ConFIG/tree/main/experiments)folder. +To reproduce the result in our paper, please check the [experiments](https://github.com/tum-pbs/ConFIG/tree/main/experiments) folder. ## Additional Information