diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml new file mode 100644 index 00000000..a6e4a368 --- /dev/null +++ b/.github/workflows/build_docs.yml @@ -0,0 +1,37 @@ +name: Build Github Pages Docs +on: + push: + branches: + - gen-1109-setup-mkdocs + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: 3.9 + + - name: Set Cache ID Based on UTC Week Number + run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + + - name: Cache dependences + uses: actions/cache@v3 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + + - name: Install mkdocs and dependencies + run: | + pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python mkdocs-open-in-new-tab + + - name: Build and deploy mkdocs site to GitHub Pages + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/README.md b/README.md index 555bb925..ba1a4c36 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,14 @@ [![Docker Automated](https://img.shields.io/docker/automated/sagebionetworks/genie.svg?style=for-the-badge&logo=docker)](https://hub.docker.com/r/sagebionetworks/genie) [![GitHub CI](https://img.shields.io/github/actions/workflow/status/Sage-Bionetworks/Genie/ci.yml?branch=develop&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/Genie) - ## Introduction This repository documents code used to gather, QC, standardize, and analyze data uploaded by institutes participating in AACR's Project GENIE (Genomics, Evidence, Neoplasia, Information, Exchange). +## Documentation + +For more information about the AACR genie repository, [visit the GitHub Pages site.](https://sage-bionetworks.github.io/Genie/) + ## Dependencies This package contains both R, Python and cli tools. These are tools or packages you will need, to be able to reproduce these results: diff --git a/docs/index.md b/docs/index.md index 404ce2d3..cfc23519 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,10 @@ [![Docker Automated](https://img.shields.io/docker/automated/sagebionetworks/genie.svg?style=for-the-badge&logo=docker)](https://hub.docker.com/r/sagebionetworks/genie) [![GitHub CI](https://img.shields.io/github/actions/workflow/status/Sage-Bionetworks/Genie/ci.yml?branch=develop&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/Genie) - ## Introduction -This repository documents code used to gather, QC, standardize, and analyze data uploaded by institutes participating in AACR's Project GENIE (Genomics, Evidence, Neoplasia, Information, Exchange). \ No newline at end of file +This repository documents code used to gather, QC, standardize, and analyze data uploaded by institutes participating in AACR's Project GENIE (Genomics, Evidence, Neoplasia, Information, Exchange). + +## Additional Documentation + +Visit the [Project Genie Data Portal](genie.synapse.org/) to learn more about our data \ No newline at end of file