diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..b937917 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,28 @@ +name: GitHub Actions +on: [push] +jobs: + Pages: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.8 ] + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: pip install poetry + - name: Activate venv + run: poetry install + - name: Build the book + run: poetry run mkdocs build --site-dir public + - name: GitHub Pages action + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./public + + + diff --git a/README.md b/README.md index 617e01e..e416d97 100644 --- a/README.md +++ b/README.md @@ -9,23 +9,21 @@ This repository serves as a hub for various Cheat Sheets related to the field of Data Science (with Python). What sets these Cheat Sheets apart is their -multi-dimensional approach to enhancing the learning experience. +multidimensional approach to enhancing the learning experience. Each Cheat Sheet is made available in three distinct formats: **PDF**, **Streamlit**, and **Google Colab**. -This triad of accessibility ensures that learners can engage with the content in -a way that suits their preferences and learning style. - +This threefold approach to guarantee that learners can interact with the content in +a manner that aligns with their preferences and learning style. **Content** - -| Topic | PDF | Streamlit | Google Colab | -|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| python | | | Open In Colab | -| numpy | | | Open In Colab | -| pandas | | | Open In Colab | -| matplotlib | | | Open In Colab | -| scikit-learn | | | Open In Colab | +| Topic | PDF | Streamlit | Google Colab | +|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| python | | | Open In Colab | +| numpy | | | Open In Colab | +| pandas | | | Open In Colab | +| matplotlib | | | Open In Colab | +| scikit-learn | | | Open In Colab | > **Note**: The PDF format cheat sheets included here are authored by other contributors and have been used as sources of inspiration for the content presented. diff --git a/docs/index.md b/docs/index.md index 0493bdf..6c5161d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,22 +5,22 @@ This repository serves as a hub for various Cheat Sheets related to the field of Data Science (with Python). What sets these Cheat Sheets apart is their -multi-dimensional approach to enhancing the learning experience. +multidimensional approach to enhancing the learning experience. Each Cheat Sheet is made available in three distinct formats: **PDF**, **Streamlit**, and **Google Colab**. -This triad of accessibility ensures that learners can engage with the content in -a way that suits their preferences and learning style. +This threefold approach to guarantee that learners can interact +with the content in a manner that aligns with their preferences and learning style. **Content** -| Topic | PDF | Streamlit | Google Colab | -|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| python | | | Open In Colab | -| numpy | | | Open In Colab | -| pandas | | | Open In Colab | -| matplotlib | | | Open In Colab | -| scikit-learn | | | Open In Colab | +| Topic | PDF | Streamlit | Google Colab | +|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| python | | | Open In Colab | +| numpy | | | Open In Colab | +| pandas | | | Open In Colab | +| matplotlib | | | Open In Colab | +| scikit-learn | | | Open In Colab | > **Note**: The PDF format cheat sheets included here are authored by other contributors and have been used as sources of inspiration for the content presented.